Refactor docs #296
Refactor docs #296
Conversation
Signed-off-by: Natalie Arellano <narellano@vmware.com>
Signed-off-by: Natalie Arellano <narellano@vmware.com>
|
Maintainers, As you review this RFC please queue up issues to be created using the following commands: Issues(none) |
Signed-off-by: Natalie Arellano <narellano@vmware.com>
Signed-off-by: Natalie Arellano <narellano@vmware.com>
Signed-off-by: Natalie Arellano <narellano@vmware.com>
natalieparellano
added
type/rfc
team/learning
scope/team
Signed-off-by: Natalie Arellano <narellano@vmware.com>
Signed-off-by: Natalie Arellano <narellano@vmware.com>
|
@natalieparellano Do you want to shepherd this, or would you prefer if I did it? |
|
@AidanDelaney if you could that'd be great :) |
|
@natalieparellano will update this RFC with some examples of what the sidebar could look like |
text/0000-re-org-docs.md
Outdated
|
|
||
| - Define the target persona: all personas, including project contributors, can benefit from this. | ||
| - Explaining the feature largely in terms of examples. | ||
| - See the example [branch](https://github.com/buildpacks/docs/tree/refactor) of github.com/buildpacks/docs and abbreviated tree with notes below. |
There was a problem hiding this comment.
An example sidebar could look like:
There was a problem hiding this comment.
WDYT @AidanDelaney?
There was a problem hiding this comment.
I like this. It's much more straightforward than what I was thinking and thus more achievable.
|
Moved to voting, closing Thurs Feb 8 :) |
text/0000-re-org-docs.md
Outdated
|
|
||
| Why should we *not* do this? | ||
| - It's a lot of work | ||
| - Changing the structure of the docs could be surprising for users who are already familiar with its content |
There was a problem hiding this comment.
It also potentially breaks SEO and links to the documentation outside of us. Will we redirect to the homepage or other pages?
Land the RFC describing how to refactor our documentation
|
I'm not sure why this hasn't been merged (as it's already been implemented 🙃) - will take a look. |
Readable