operate-first / operate-first.github.io-old

GNU General Public License v3.0
18 stars 42 forks source link

Switch hitchiker with handbook, and add remote link support. #336

Closed HumairAK closed 2 years ago

HumairAK commented 2 years ago

As per: https://github.com/operate-first/SRE/issues/424#issuecomment-970422981 Will resolve: https://github.com/operate-first/apps/issues/1406

This is by no means a finalized version of the ToC, but to clean up what currently exists and start moving us in the right direction.

Changes:

Ninja changes that I snuck in:

netlify[bot] commented 2 years ago

✔️ Deploy Preview for relaxed-goldstine-ebb96e ready!

🔨 Explore the source changes: 5389dea79fba17769cb711b5d92d4bbf75a90512

🔍 Inspect the deploy log: https://app.netlify.com/sites/relaxed-goldstine-ebb96e/deploys/61a8e437d131cd0007a14f31

😎 Browse the preview: https://deploy-preview-336--relaxed-goldstine-ebb96e.netlify.app

HumairAK commented 2 years ago
12:46:35 PM: Build exceeded maximum allowed runtime
12:47:59 PM: Error cloning repository: https://github.com/operate-first/operate-first.github.io

well then...

HumairAK commented 2 years ago

@tumido how can we retry this build?

quaid commented 2 years ago

Cool, I'll ack this after a few comments:

This is by no means a finalized version of the ToC, but to clean up what currently exists and start moving us in the right direction.

This looks really good, and it's helping clarify how to think about the Community Handbook and site layout.

For site layout, I opened Website map for Dec 2021 changes.

For layout (table of contents basically) within the Community Handbook, it sounds like you are defining and renaming what is effectively a sub-section of the Handbook focused on getting things done when operating the Op1st community cloud. Is that a fair way to view it? Then we can have all the ToC work in that area done by experts/experienced, and we can get reviews from the non-experienced people to provide the new-person perspective.

Then I'd like us to open a PR to hook in pages in operate-first/community-handbook/ including the overall entire Handbook ToC. What we want to see is the link on the website to the top level of Community Handbook should link to a ToC and introduction that's maintained in operate-first/community-handbook/. (And all the sub-directories of indices and markdown pages should be automatically built into the website under Community Handbook.)

Maybe we can meet on Slack and do that coordination?

Changes:

  • I've rebranded HitchHiker's Guide section as "Community Handbook", replaced the intro with the handbook intro, and added a link to our gitops docs (docs for apps repo).

Yeah, this is fine as we evolve I think, but I'd like to see us moving to the above approach (or similar) for setting up the Community Handbook.

As a large-scale sophisticated example, here is the Ops Sub-department page at GitLab: https://about.gitlab.com/handbook/engineering/development/ops/

If we imagine what an Operations SIG for Op1st would look like? It would have some of the similar organizational, process, and communication information, certainly. But it would also have a full library of GitOps reference pages and comprehensive how-we-do-things pages (that can/should be Jupyter notebooks, it's seeming.)

/lgtm

HumairAK commented 2 years ago

/hold

Need to fix a few things, the TOC should not have been removed for the 3 tabs

HumairAK commented 2 years ago

Preview is up @durandom @quaid can you guys take a look: https://deploy-preview-336--relaxed-goldstine-ebb96e.netlify.app/

HumairAK commented 2 years ago

Side note: we need a follow up PR that updates this page: https://github.com/HumairAK/operate-first.github.io/blob/community_hb/content/community-handbook/index.md

As that is a content update, I do not think it belongs to this PR. I think that's something better suited for @quaid or someone more involved with the over arching handbook initiative to change :)

quaid commented 2 years ago

Preview is up @durandom @quaid can you guys take a look: https://deploy-preview-336--relaxed-goldstine-ebb96e.netlify.app/

I have one question I'll put in as a comment on the commit, no fixes to the PR. This looks very good and I see how straightforward it is building the ToC in the yaml file, how to pull in from across the repos, and so forth.

/lgtm /approve

quaid commented 2 years ago

Preview is up @durandom @quaid can you guys take a look: https://deploy-preview-336--relaxed-goldstine-ebb96e.netlify.app/

I have one question I'll put in as a comment on the commit, no fixes to the PR. This looks very good and I see how straightforward it is building the ToC in the yaml file, how to pull in from across the repos, and so forth.

/lgtm /approve

The question I had is about ‘community-docs.yaml’, line 7 calls something about git docs that doesn't appear in your preview build. What is happening there?

HumairAK commented 2 years ago

@quaid not sure what file is that, I don't see it -- can you link to the file/line?