Page MenuHomePhabricator

Review critical-path deployment pipeline documentation
Closed, ResolvedPublic

Description

Make sure that documentation pages listed below are complete, correct, and up to date:

Blubber:

GitLab:

Kokkuri:

Helm:

Please reach out to @KBach if you need help, feedback, or want to collaborate on any of these. Feel free to create sub-tasks for any of these if necessary.

Event Timeline

KBach updated the task description. (Show Details)

I verified https://www.mediawiki.org/wiki/GitLab/Publishing_docs is complete and reflects the current state of the doc publisher. Removed the "draft" marker.

https://www.mediawiki.org/wiki/GitLab/Hosting_a_project_on_GitLab - general review, complete the document

I made a series of small edits here, and cleared some outdated TODOs. I'm not sure if it's fully complete, but I believe it more or less reflects the current state of affairs.

brennen changed the task status from Open to In Progress.Jan 19 2024, 9:09 PM
brennen added a project: User-brennen.
brennen moved this task from Backlog to Radar on the User-brennen board.
dduvall subscribed.

Sorry for the delay on my side. Assigning to myself as I think I'm the only one that still needs to perform review.

Blubber:

LGTM.

I removed the page content and left a deprecation note that links to the project README.

It looks accurate, but I do not like this page. It's much too dense and mislabeled as a guide when it's really a reference.

I'm working on an MR for Blubber that introduces a JSON Schema for base validation and generates a docs/configuration.md file from the schema.

Kokkuri:

Both of these look good to me.

dduvall triaged this task as Medium priority.Feb 6 2024, 11:08 PM

This is great, thank you everyone!

It looks accurate, but I do not like this page. It's much too dense and mislabeled as a guide when it's really a reference.

I'm working on an MR for Blubber that introduces a JSON Schema for base validation and generates a docs/configuration.md file from the schema.

@dduvall do you think it makes sense for me to rename the User Guide (to Reference or similar) and review it slightly? Or should we wait for your mechanism of generating docs/configuration.md to be ready and deprecate the User Guide entirely when it's available?

KBach added a subscriber: kamila.

Helm-related pages have been confirmed correct and up-to-date by @kamila

@dduvall do you think it makes sense for me to rename the User Guide (to Reference or similar) and review it slightly? Or should we wait for your mechanism of generating docs/configuration.md to be ready and deprecate the User Guide entirely when it's available?

@dancy reviewed my MR (thanks, Ahmon!) and I just merged it. Does this look like a good start? We can add more property descriptions if that's helpful but this should be a more maintainable source of truth. Moreover, it is actually used to validate config now.

We can even move some of the regex based validations into the schema and render those patterns into the document. There are some validations which have to stay in Go due to the complexity, but not many.

https://gitlab.wikimedia.org/repos/releng/blubber/-/blob/main/docs/configuration.md?ref_type=heads

Renaming/moving the guide page to Reference and linking to this upstream doc makes sense to me. I'll go ahead and do that.

Additionally for Blubber, I deprecated the Getting Started pages and Deployment Pipeline documentation and removed them from the portal. I renamed Usage to Examples and linked to the project examples folder which contains acceptance tests with descriptions for people. I added a Reference page and portal item and linked to the project's docs/configuration.md file.

The only weird thing about the Blubber portal now is that all items link to pages which then redirect to external sources. It would be nice to figure out whether the portal template can play nicely with external links but I couldn't get them to work.

All pages in scope of this task have now been reviewed. Marking as resolved.

@dancy reviewed my MR (thanks, Ahmon!) and I just merged it. Does this look like a good start? We can add more property descriptions if that's helpful but this should be a more maintainable source of truth. Moreover, it is actually used to validate config now.

@dduvall This is great. I have scheduled a meeting for us to talk about how it works and how we can improve it.

Additionally for Blubber, I deprecated the Getting Started pages and Deployment Pipeline documentation and removed them from the portal. I renamed Usage to Examples and linked to the project examples folder which contains acceptance tests with descriptions for people. I added a Reference page and portal item and linked to the project's docs/configuration.md file.

These are all good changes, thanks! My only concern is that docs/configuration.md is a bit difficult to read and is missing some information that was previously available in the User Guide. Because of that I have temporarily brought back the majority of User Guide content and added it, with minor edits, to the Reference page. I'm sure we'll be able to remove it again once we improve configuration.md a bit. Hope that's OK.

The only weird thing about the Blubber portal now is that all items link to pages which then redirect to external sources. It would be nice to figure out whether the portal template can play nicely with external links but I couldn't get them to work.

I see what you mean and will try to fix it as part of T352264.