docs: Consolidate DD library docs links#673
Conversation
Signed-off-by: Mike Knepper <mknepper@nvidia.com>
📝 WalkthroughWalkthroughData Designer overview, migration, and tutorial pages now use internal ChangesData Designer documentation links
Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
Signed-off-by: Mike Knepper <mknepper@nvidia.com>
Signed-off-by: Mike Knepper <mknepper@nvidia.com>
|
Signed-off-by: Mike Knepper <mknepper@nvidia.com>
Signed-off-by: Mike Knepper <mknepper@nvidia.com>
Signed-off-by: Mike Knepper <mknepper@nvidia.com>
| Move configurations between local CLI and NeMo Services execution. | ||
|
|
||
| </Card> | ||
| <Card title="Library Documentation" href="https://docs.nvidia.com/nemo/datadesigner/v0.7.0/getting-started/welcome"> |
There was a problem hiding this comment.
This card component is the only link to upstream DD docs that isn't a standard Markdown link, and it isn't especially valuable as a card here anyways, so I'm just deleting it.
|
|
||
| redirects: | ||
| # Upstream Data Designer library pages, targeting a specific library version | ||
| # TODO: add version path component once v0.7.0 is accessible explicitly |
There was a problem hiding this comment.
Currently, the DD library only publishes the latest version of the docs with no version component at all, so we can't actually explicitly target a specific version when that version is the latest. This is getting fixed in the upstream library
| - source: "/data-designer-library/:slug*" | ||
| destination: "https://docs.nvidia.com/nemo/datadesigner/:slug*" |
There was a problem hiding this comment.
This redirect approach seems the best option for consolidating the upstream DD library links:
- it achieves the goal of specifying the library version just once, here
- it allows authors to write normal-looking Markdown links (don't have to use a custom
<DataDesignerDocsLink>component - it's short
There is one unfortunate side-effect: fern's broken-links check doesn't understand redirects, and so all the DD links are flagged as broken 😒 These are currently only warnings, not errors, but still: not great. My agent suggested wrapping the broken-links check in a script that ignores the data-designer-library references. I'm tempted to punt that until we start actually blocking in CI on broken links (there is an existing one on main related to auth).
I also considered a pattern in which authors provide full-but-unversioned links in the markdown, and we use redirects to target the specific version. So for example the author would write [custom columns](https://docs.nvidia.com/nemo/datadesigner/custom-columns) and the redirect config would add in the version. Unfortunately, this does not work: you can't redirect from external sources, only from internal references (e.g. /foo); this also produced a slew of TypeErrors in Fern, including for completely unrelated links in the docs.
There was a problem hiding this comment.
The other weird thing about this approach is that if you right-click the link and select "Copy link address", you get the invalid, pre-redirected link. Example from the preview build:
If you paste that into a browser and try to hit it, it does correctly redirect, but it's still a little weird...
There was a problem hiding this comment.
wow this is annoying lol. I guess it's valid technically as a link, just not to the final destination
mckornfield
left a comment
There was a problem hiding this comment.
I honestly don't know if this is an improvement with how weird it is. I will stamp it though if you feel it is hahaha
|
Chatted in Slack and we don't like any of the options enough. In particular, the |
Summary by CodeRabbit