Skip to content
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

Organize old wiki docs into folders #2

Merged
merged 15 commits into from
Sep 20, 2021
Merged

Conversation

sandy-wright
Copy link
Contributor

Description

I created a simple folder structure in the docs/ directory, and moved the docs from the wiki to the folder I thought was most appropriate. I also added a couple of index pages that have not yet been fleshed out. I didn't change anything in the docs other than that! So it looks huge, but it was just shuffling a bunch of things.

Please also note that I added a Vault directory. This will serve as an archive folder. We can move docs here when we're not sure where they belong, or we aren't sure if they're still accurate or needed. Right now, it contains documents that I'm sure should be moved to Confluence (in the docs/vault/confluence dir) and infra documentation that I'm not sure should be moved, but I think probably should also be in Confluence (in the docs/vault/infra dir).

This won't be deployed to github pages, so you'll need to run it locally to see the changes. I also highly recommend doing this because it'll be almost impossible to actually absorb the changes I made unless you experience it in the app.

To do this, run:

yarn install
yarn start

@sandy-wright sandy-wright requested a review from a team September 20, 2021 18:35
@rogeruiz
Copy link
Contributor

rogeruiz commented Sep 20, 2021

This looks great @sandy-wright! I'm wondering if for docs that go in Vault if it makes sense to version the documentation or rename the folder to Deprecated instead?

For versioning the idea would be that there is a current version and a deprecated version. I do not want to introduce semantic versioning to our documentation.

I don't think answering the question should stop this from getting merged in. But I'm curious what your thoughts are on this.

@scarequotes
Copy link
Contributor

Thank you for all the Terminal setup @sandy-wright — looks great to me!

@sandy-wright
Copy link
Contributor Author

This looks great @sandy-wright! I'm wondering if for docs that go in Vault if it makes sense to version the documentation or rename the folder to Deprecated instead?

For versioning the idea would be that there is a current version and a deprecated version. I do not want to introduce semantic versioning to our documentation.

I don't think answering the question should stop this from getting merged in. But I'm curious what your thoughts are on this.

My thought around naming it "Vault" was that it could be a generic space for docs that didn't have a clear home. This could included deprecated docs, maybe docs in progress, or docs that need to be moved elsewhere. I felt like "Archive" or "Deprecated" might be too restrictive to encompass all that.

That said, part of my reasoning was also "V is near the end of the alphabet so the vault is the last folder in docs/! 😄 ", which is a little silly. I'm totally fine with renaming it if that's the clearest path forward.

When it comes to versioning, I'm not sure! Maybe that means the "Deprecated" directory should be in a different folder completely? How would you envision the versioning process working (since it wouldn't be semantic versioning)? We can also continue this convo outside of github too! Maybe at the docs meeting tomorrow

@sandy-wright sandy-wright merged commit 720592c into main Sep 20, 2021
@sandy-wright sandy-wright deleted the organize-docs-folders branch September 20, 2021 22:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants