Skip to content

Configure documentation toolchain with antsibull-docs #109

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 46 commits into from
Sep 27, 2023
Merged

Configure documentation toolchain with antsibull-docs #109

merged 46 commits into from
Sep 27, 2023

Conversation

@wmudge
Copy link
Member

@wmudge wmudge commented Sep 15, 2023

Update the collection to build API docs on both pushes to main but also via dispatch.

@wmudge wmudge added documentation Improvements or additions to documentation enhancement MINOR - New feature or enhancement in the CHANGELOG labels Sep 15, 2023
@wmudge wmudge requested a review from a team September 15, 2023 15:14
@github-actions github-actions bot added validated The pull request has passed the prechecks and removed validated The pull request has passed the prechecks labels Sep 15, 2023
@wmudge wmudge force-pushed the update/antsibull-docs branch from c3b3515 to 9c8692d Compare September 15, 2023 21:13
@github-actions github-actions bot added validated The pull request has passed the prechecks and removed validated The pull request has passed the prechecks labels Sep 15, 2023
@wmudge wmudge force-pushed the update/antsibull-docs branch from 9c8692d to 740fd16 Compare September 15, 2023 21:24
@github-actions github-actions bot added validated The pull request has passed the prechecks and removed validated The pull request has passed the prechecks labels Sep 15, 2023
@wmudge wmudge force-pushed the update/antsibull-docs branch from 740fd16 to 851f1f0 Compare September 15, 2023 21:54
@github-actions github-actions bot added validated The pull request has passed the prechecks and removed validated The pull request has passed the prechecks labels Sep 15, 2023
@wmudge wmudge force-pushed the update/antsibull-docs branch from 851f1f0 to 170c69e Compare September 15, 2023 23:15
@github-actions github-actions bot removed the validated The pull request has passed the prechecks label Sep 15, 2023
@wmudge wmudge force-pushed the update/antsibull-docs branch from 170c69e to 872908a Compare September 15, 2023 23:16
@github-actions github-actions bot added the validated The pull request has passed the prechecks label Sep 15, 2023
@wmudge wmudge mentioned this pull request Sep 18, 2023
Closed
@github-actions github-actions bot added validated The pull request has passed the prechecks and removed validated The pull request has passed the prechecks labels Sep 18, 2023
@wmudge wmudge force-pushed the update/antsibull-docs branch from 2d2ee5d to 1d18b40 Compare September 18, 2023 17:57
@github-actions github-actions bot added validated The pull request has passed the prechecks and removed validated The pull request has passed the prechecks labels Sep 18, 2023
@github-actions github-actions bot added validated The pull request has passed the prechecks and removed validated The pull request has passed the prechecks labels Sep 27, 2023
jimright
jimright requested changes Sep 27, 2023
View reviewed changes
Copy link
Contributor

@jimright jimright left a comment

Choose a reason for hiding this comment

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

In general this looks good. Just had 2 questions about the details exposed in the integration tests.

wmudge added 18 commits September 27, 2023 11:56
@wmudge
Update to use common reusable workflows
d47cadb 
Signed-off-by: Webster Mudge <wmudge@cloudera.com>
@wmudge
Comment out additional API docs sections
3309a0d 
Signed-off-by: Webster Mudge <wmudge@cloudera.com>
@wmudge
Update README for API and installation instructions
9864fe1 
Signed-off-by: Webster Mudge <wmudge@cloudera.com>
@wmudge
Add pointer for building a local tarball of the collection
0296e1a 
Signed-off-by: Webster Mudge <wmudge@cloudera.com>
@wmudge
Remove unused example documentation
17ff148 
Signed-off-by: Webster Mudge <wmudge@cloudera.com>
@wmudge
Update top links to point at Cloudera.com sites
fd3f96b 
Signed-off-by: Webster Mudge <wmudge@cloudera.com>
@wmudge
Split out contribute guidance into a separate file
c5a2518 
Signed-off-by: Webster Mudge <wmudge@cloudera.com>
@wmudge
Update the collection metadata to remove authors at this level
8abcc22 
Signed-off-by: Webster Mudge <wmudge@cloudera.com>
@wmudge
Update the README with a preamble, roadmap, and revamp contribution s…
75c9852 
…ection

Signed-off-by: Webster Mudge <wmudge@cloudera.com>
@wmudge
Update formatting
4fbbff3 
Signed-off-by: Webster Mudge <wmudge@cloudera.com>
@wmudge
Update backlog docs and query
45497e6 
Signed-off-by: Webster Mudge <wmudge@cloudera.com>
@wmudge
Format galaxy.yml for consistency
9bbf4fe 
Signed-off-by: Webster Mudge <wmudge@cloudera.com>
@wmudge
Add note about ansible-builder and adjust some formatting
f73b04f 
Signed-off-by: Webster Mudge <wmudge@cloudera.com>
@wmudge
Update branching instructions for clarity
fc8b274 
Signed-off-by: Webster Mudge <wmudge@cloudera.com>
@wmudge
Clarify the use of ansible-builder for Python dependencies
48e2a2e 
Signed-off-by: Webster Mudge <wmudge@cloudera.com>
@wmudge
Update copyright date
094e5f2 
Signed-off-by: Webster Mudge <wmudge@cloudera.com>
@wmudge
Clarify ansible-builder operations and Python dependencies
f9c6f46 
Signed-off-by: Webster Mudge <wmudge@cloudera.com>
@wmudge
Add note about Collection Metadata usage and update callout formatting
ef7d10c 
Signed-off-by: Webster Mudge <wmudge@cloudera.com>
@wmudge wmudge force-pushed the update/antsibull-docs branch from cccd13e to ef7d10c Compare September 27, 2023 15:57
@github-actions github-actions bot added validated The pull request has passed the prechecks and removed validated The pull request has passed the prechecks labels Sep 27, 2023
@wmudge
Update to use the public TF quickstart module
4e332fe 
Signed-off-by: Webster Mudge <wmudge@cloudera.com>
@github-actions github-actions bot added validated The pull request has passed the prechecks and removed validated The pull request has passed the prechecks labels Sep 27, 2023
jimright
jimright approved these changes Sep 27, 2023
View reviewed changes
Copy link
Contributor

@jimright jimright left a comment

Choose a reason for hiding this comment

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

Looks good. Approved.

@wmudge wmudge merged commit 95bd084 into cloudera-labs:devel Sep 27, 2023
@wmudge wmudge deleted the update/antsibull-docs branch September 27, 2023 21:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jimright jimright jimright approved these changes

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation enhancement MINOR - New feature or enhancement in the CHANGELOG validated The pull request has passed the prechecks

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@wmudge @jimright