Skip to content

Upload cookbook docs to artifacts #1981

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

Closed
wants to merge 3 commits into from
Closed

Upload cookbook docs to artifacts #1981

wants to merge 3 commits into from

Conversation

Ifropc
Copy link
Contributor

@Ifropc Ifropc commented Mar 20, 2025

What

Uploads cookbook docs to artifacts

Why

To decouple cookbook docs from our actual release and avoid potential breakage
docs PR: stellar/stellar-docs#1439

Known limitations

I manually uploaded artifact produced by the latest run to 22.6.0 release

@github-project-automation github-project-automation bot moved this to Backlog (Not Ready) in DevX Mar 20, 2025
@Ifropc Ifropc marked this pull request as ready for review March 20, 2025 19:22
@Ifropc Ifropc requested a review from a team March 20, 2025 19:22
Copy link
Member

@fnando fnando left a comment

Choose a reason for hiding this comment

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

Great idea!


- name: Compress
run: |
tar czvf ${{ env.NAME }}.tar.gz cookbook FULL_HELP_DOCS.md
Copy link
Member

Choose a reason for hiding this comment

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

The cookbook and full help are different things. The full help docs is referred to as the user manual in the docs, so I think we should rename the job to User Manual. We could rename the .md file to USER_MANUAL too maybe for consistency.

Copy link
Contributor Author

@Ifropc Ifropc Mar 20, 2025

Choose a reason for hiding this comment

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

Do you think we should upload FULL_HELP_DOCS.md and cookbook.tar.gz as separate artifacts?
Because the artifacts are not intended to be used by the end user, just by our docs, so I think it makes sense to keep it in 1 tar, and keep the naming the same to avoid confusion by developers

Copy link
Member

Choose a reason for hiding this comment

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

I think they should be separate. And named by what they contain. The user manual is at least maybe interesting to others.

@leighmcculloch
Copy link
Member

To decouple cookbook docs from our actual release and avoid potential breakage

The PR description says the aim is to decouple cookbook docs from the CLI release, however this PR seems to explicitly make the cookbooks a release artifact, therefore further coupling the cookbooks to the release. 🤔

Is the goal to be able to regenerate and rewrite the release cookbook artifact in cases when the cookbook has an error? 🫨

Setting up a process to rewrite release artifact's is somewhat terrifying, as the release artifacts should be built one time, from the release itself and never tampered with.

The underlying issue seems to me to be that the cookbooks in this repo are not being tested, and if they're to live in this repo instead of the stellar-docs repo, they should probably be tested here. Have we explored that option?

@Ifropc
Copy link
Contributor Author

Ifropc commented Mar 24, 2025

Yes, the idea is to combine this approaches (see #1908)
The reason we want to put docs into artifacts is that if somehow we still break the docs, we can simply just replace broken artifact with a working one (though with docs validation this should never happen)

@Ifropc Ifropc requested a review from leighmcculloch March 25, 2025 18:05
@Ifropc
Copy link
Contributor Author

Ifropc commented Mar 26, 2025

We decided not to to with this approach

@Ifropc Ifropc closed this Mar 26, 2025
@github-project-automation github-project-automation bot moved this from Backlog (Not Ready) to Done in DevX Mar 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants