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

Rework the documentation around our cloud services #97

Merged
merged 9 commits into from
Sep 22, 2021
Merged

Conversation

choldgraf
Copy link
Member

@choldgraf choldgraf commented Sep 20, 2021

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:

  • Uses the PyData Sphinx Theme so that we have more consistent style / structure with our 2i2c.org website
  • Splits this documentation into two major sections: one for hub Administrators, and one about the service itself.
  • Adds more meta-information about the cloud services in general, a overview matrix of features, and pages for each of the two major hub distributions that we offer.
  • Adds a bit more build infrastructure to make it easier to build the docs locally.

Here'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

AE3D2mS5p2

In addition to this, I'd also like to make the following URL changes:

  • Make docs.2i2c.org point to this site
    • The Hub Administrator guide would then be available at docs.2i2c.org/admin
    • The "About our Service" guide would be available at docs.2i2c.org/about
  • Make devops.2i2c.org point to our current pilot-hubs documentation

part of https://github.com/2i2c-org/meta/issues/78

about/overview.md Outdated Show resolved Hide resolved
Copy link
Contributor

@colliand colliand left a 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.

@choldgraf
Copy link
Member Author

choldgraf commented Sep 21, 2021

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:

  • Re-works this site to be more of a high level documentation that points to other places. I imagine we can host this at docs.2i2c.org.
  • Updates the logo to be further in-line with 2i2c.
  • Includes links to our Hub Engineer's guide (which I'm calling the DevOps Guide since I suspect that will be more descriptive than Hub Engineer) as well as our Team Compass

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 pilot-hubs and team-compass can still provide a lot of value to outside stakeholders, and help us emerge as a leader in open and inclusive organizations, so we should encourage that others look at them.

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.

@choldgraf choldgraf requested a review from colliand September 21, 2021 19:21
@choldgraf
Copy link
Member Author

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 🙂)

Copy link
Member

@sgibson91 sgibson91 left a 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

@choldgraf choldgraf merged commit 5bc2aac into main Sep 22, 2021
@choldgraf choldgraf deleted the service branch September 22, 2021 20:30
@choldgraf
Copy link
Member Author

thanks @sgibson91 and @colliand for taking a look@!

@damianavila
Copy link
Contributor

damianavila commented Sep 22, 2021

Late to the party but I really like this one 😉 .

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.

4 participants