Reorganize docs #5535
Reorganize docs #5535
Conversation
|
Just curious why this shows up as all added lines? Did you not remove the old files from the old locations? Also, nitpick: I'd prefer assets to be a non-hidden directory. Yeah, you don't need to see them when browsing, but they're going to be edited a bunch so better to have them visible |
|
+1 to preserving the git history. +1 to non-hidden assets folder. |
Wow, yeah I didn't delete from the previous location. I swear I used a move refactor in GoLand... Anyway, it's fixed now.
I also don't want it to be hidden, but I want it to somehow show up as separate from the other things in the docs folder. I changed the period to be an underscore. |
## What changed?
<!-- Describe what has changed in this PR -->
I reorganized our docs into `docs/{admin,architecture,development}`.
## Why?
<!-- Tell your future self why have you made these changes -->
We discussed this internally, but I believe this is a better
segmentation for the different audiences looking at our docs. I plan on
adding more stuff to docs/admin like metrics and dynamic config docs.
## How did you test it?
<!-- How have you verified this change? Tested locally? Added a unit
test? Checked in staging env? -->
I'm mainly looking for broken links.
- I went through each markdown file in docs manually.
- I looked through all inspection errors in the IDE.
- I looked at all references to "docs/" or "develop/" in our code.
## Potential risks
<!-- Assuming the worst case, what can be broken when deploying this
change to production? -->
## Documentation
<!-- Have you made sure this change doesn't falsify anything currently
stated in `docs/`? If significant
new behavior is added, have you described that in `docs/`? -->
## Is hotfix candidate?
<!-- Is this PR a hotfix candidate or does it require a notification to
be sent to the broader community? (Yes/No) -->
What changed?
I reorganized our docs into
docs/{admin,architecture,development}.Why?
We discussed this internally, but I believe this is a better segmentation for the different audiences looking at our docs. I plan on adding more stuff to docs/admin like metrics and dynamic config docs.
How did you test it?
I'm mainly looking for broken links.
Potential risks
Documentation
Is hotfix candidate?