-
Notifications
You must be signed in to change notification settings - Fork 627
Closed
Labels
module: docIssues related to documentation, both in docs/ and inlined in codeIssues related to documentation, both in docs/ and inlined in codemodule: user experienceIssues related to reducing friction for usersIssues related to reducing friction for userstriagedThis issue has been looked at a team member, and triaged and prioritized into an appropriate moduleThis issue has been looked at a team member, and triaged and prioritized into an appropriate module
Milestone
Description
📚 The doc issue
With the new documentation flow, I've moved, renamed, or split out a number of docs. There are hard-coded links in various readme files in the ET repo to stable/ docs. These are tricky to handle, because we can't easily relative link from readmes in the repo to docs (it likely should point to stable). So if we point to the new locations, it's broken now. If we don't, it breaks on the next release (when the new docs are promoted to stable).
To solve this, I see two options:
- Fix the links during the 0.6 release process.
- Set up redirects to handle the main moved pages (getting-started-setup being the most common one).
I'm leaning towards (2), then fixing the links permanently after 0.6 hits stable.
Suggest a potential alternative/fix
No response
Metadata
Metadata
Assignees
Labels
module: docIssues related to documentation, both in docs/ and inlined in codeIssues related to documentation, both in docs/ and inlined in codemodule: user experienceIssues related to reducing friction for usersIssues related to reducing friction for userstriagedThis issue has been looked at a team member, and triaged and prioritized into an appropriate moduleThis issue has been looked at a team member, and triaged and prioritized into an appropriate module
Type
Projects
Status
Done