-
Notifications
You must be signed in to change notification settings - Fork 17
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
Rework the documentation around our cloud services #97
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.
I like the changes! I added a few comments while reviewing. I don't think we are in final form but see these as a significant improvement. I suggest we merge and continue our work together.
I made another update after a recent conversation with @colliand. It took inspiration from the Strip documentation, which has been pointed out as a good example to follow. It makes the following changes:
The reasoning for adding the last two links is that (as @colliand insightfully put it to me), part of 2i2c's mission is to provide transparency into how it operates, and how others might follow our path. As such, our "internal" documents like would love feedback - particularly from @colliand if he thinks this is a step in the right direction. If so, and if nobody from the tech team objects, I suggest we merge this and iterate from there. |
OK I think this is more-or-less ready to go. There's still a lot more to improve, but this is I think a good step. I'll leave it open for a day or two to see if others have ideas (or objections 🙂) |
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 really like this! Feels clean and easy to navigate
thanks @sgibson91 and @colliand for taking a look@! |
Late to the party but I really like this one 😉 . |
After a recent conversation with @colliand and the CS&S folks, this is a re-working of the "pilot documentation" to prepare for an "alpha" launch of the hub service. It does the following major things:
2i2c.org
websiteHere's a quick GIF of the header of this site compared with 2i2c.org, along with the changes also proposed in 2i2c-org/2i2c-org.github.io#69
In addition to this, I'd also like to make the following URL changes:
docs.2i2c.org
point to this sitedocs.2i2c.org/admin
docs.2i2c.org/about
devops.2i2c.org
point to our currentpilot-hubs
documentationpart of https://github.com/2i2c-org/meta/issues/78