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

Add structured repo docs #586

Merged
merged 1 commit into from
Jul 21, 2022
Merged

Conversation

daviddavis
Copy link
Contributor

@daviddavis daviddavis commented Jul 15, 2022

The script in the docs will be tested by the CI:

export POST_DOCS_TEST=$PWD/.github/workflows/scripts/post_docs_test.sh

if [ -f $POST_DOCS_TEST ]; then
source $POST_DOCS_TEST
fi

@daviddavis daviddavis force-pushed the add-structured-repo-docs branch 11 times, most recently from b8352cf to 44a6dbe Compare July 15, 2022 16:06
Copy link
Contributor

@hstct hstct left a comment

Choose a reason for hiding this comment

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

If we can add an expected output this looks good to me.

docs/_scripts/structured_repo.sh Show resolved Hide resolved
Copy link
Collaborator

@quba42 quba42 left a comment

Choose a reason for hiding this comment

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

Since a full rework of the existing docs won't happen any time soon, and this PR brings an obvious benefit (docs for a workflow that was previously undocumented), I am not too worried about making the style perfectly consistent with the existing docs.

Since @hstct says he tried out the workflow and it worked, I say we merge. Perhaps after my nitpick with the change note is resolved 😄.

Thanks a ton @daviddavis for providing these docs, and @hstct for the initial review!

CHANGES/586.docs Outdated Show resolved Hide resolved
docs/_scripts/setup.sh Show resolved Hide resolved
@quba42 quba42 merged commit 7113944 into pulp:main Jul 21, 2022
@quba42 quba42 added .doc CHANGES/<issue_number>.doc backport-2.19 labels Jul 25, 2022
@patchback
Copy link

patchback bot commented Jul 25, 2022

Backport to 2.19: 💚 backport PR created

✅ Backport PR branch: patchback/backports/2.19/71139448680e01f9aa0fe1a6909a7039a98a70df/pr-586

Backported as #593

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
.doc CHANGES/<issue_number>.doc
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants