New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
CB-13333: Move "Instructions" to /doc #737
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall, I like the splitting of the files because it's organised, but I'm also a bit skeptical because it might be less read this way.
What do you think? This way, might people be less likely to read the (very important) redirect docs?
doc/redirects.md
Outdated
|
||
- `general`: single-page redirects. | ||
- `docs-global`: redirects across all docs versions and languages, | ||
- `docs`: version-specific docs redirects, and |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The items in this list are in the wrong order.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hm, strange how this happened, these are indeed different than in the original.
But why is this "wrong", what defines the order?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just the commas and the "and". I'm just pointing out that the writing is currently wrong, so it just needs to be fixed to match, or the order should be back to what it was before. The actual order doesn't matter.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh, right. Blind from looking at it.
Fixed.
|
||
**NOTE**: Review (and test, if possible) these redirects before making them live, since they're permanent (HTTP 301) redirects. Incorrect permanent redirects will make a URI almost impossible to bring back into browsers and search indices. | ||
|
||
## Changing Docs URIs |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why is this a new section?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I felt the list of cases below required a "parent" headline. Is it factually wrong? Or should the general
above also get one?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's not wrong. It was just all one section before, so I'm wondering why you split it into two sections. Both are OK.
I hope not - having clearly defined files should make it easier to read the stuff that actually matters. Of course we might want to link to it (and highlight its importance) at the correct places. (The README in general needs additional work for that. Maybe a list of "Guides" or "Common Tasks" after the introduction and before the install/build/develop/deploy [which maybe also could be extracted to their own files]?) |
…case apps to individial files in /doc (Only minimal changes to actual instructions)
Move instructions about blogposts, redirects and adding tools or showcase apps to individial files in /doc
(Only minimal changes to actual instructions)