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

Rearrange Documentation Folder #210

Merged
merged 28 commits into from
Dec 16, 2021

Conversation

noursaidi
Copy link
Collaborator

Builds on PR #196 to rearrange the documentation folders.

readme's for the new directories to come in a future update, as will documentation for the new items in the list

Comments on the PR were incorporated. Additional changes were also:

  • Renamed messages to messaging like status, pointset aren't messages but are part of the messages; and we also have the schema)
  • Moved metadata out of the messages directory
  • Renamed dashboard to cloud
  • Renamed config writeback to writeback
  • Renamed implementation guide to guides

@noursaidi noursaidi requested review from grafnu and pisuke December 7, 2021 10:25
Copy link
Collaborator

@grafnu grafnu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall looks good, thanks. I think a few top-level names are inconsistent and should be munged just a bit:

specification --> specs
messaging--> messages
transactions --> sequences (nothing inherently wrong with transactions, but the testing code currently calls them sequences so trying to be consistent)
cloud --> clouds/gcp

Also, I wouldn't put "messages" under "specification" -- I think messages is significant enough to be its own top level entry.

I'm not sure the "applications" hierarchy is useful... there are tools (e.g. pubber.md) and then cloud stuff (clouds/gcp) -- but the cloud stuff isn't really tools, it's a complete ecosystem.

@pisuke pisuke mentioned this pull request Dec 8, 2021
@noursaidi noursaidi merged commit 1e8a83f into faucetsdn:master Dec 16, 2021
@noursaidi noursaidi deleted the docs-update-relocate branch September 20, 2022 13:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants