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

Drop Scenario Guides #2022

Conversation

mariolenz
Copy link
Collaborator

@mariolenz mariolenz commented Mar 13, 2024

SUMMARY

Those scenario guides are pretty outdated, most of them 3 years old. I think it's better to remove them instead of keeping outdated documentation.

ISSUE TYPE
  • Docs Pull Request

Copy link

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/7d03ed3a49eb4065af2ded3518742b41

✔️ ansible-tox-linters SUCCESS in 10m 11s
✔️ build-ansible-collection SUCCESS in 11m 14s
✔️ ansible-galaxy-importer SUCCESS in 10m 03s

@mariolenz mariolenz changed the title [WIP] Fix CI issues with antsibull-docs 2.8.0 Drop Scenario Guides Mar 13, 2024
Copy link

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/bf013aeba5184536b3511c02d2a33e7d

✔️ ansible-tox-linters SUCCESS in 11m 01s
✔️ build-ansible-collection SUCCESS in 11m 26s
✔️ ansible-galaxy-importer SUCCESS in 5m 14s

@mariolenz mariolenz requested a review from ihumster March 13, 2024 18:30
Copy link
Contributor

@samccann samccann left a comment

Choose a reason for hiding this comment

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

LGTM

@ihumster
Copy link
Collaborator

Do we want to offer something in return?

@mariolenz
Copy link
Collaborator Author

Do we want to offer something in return?

I'm not sure. The problem is that we would have to keep the documentation up to date and we already have problems with keeping up with all the isuues and PRs. So, yes, it would be nice to have some some kind of scenario guides or similar, but who's going to maintain that?

FYI My main reason to remove the scenario guides is that they fail the CI since the last antsibull-docs docs release and I didn't find a way to fix this. Droping them completely saves a lot of work and prevents to run into similar situations in the future.

@mariolenz mariolenz added documentation Improvements or additions to documentation mergeit labels Mar 14, 2024
Copy link

Build succeeded (gate pipeline).
https://ansible.softwarefactory-project.io/zuul/buildset/f9b49781cca84dc8ad65c0689e5a97ca

✔️ ansible-tox-linters SUCCESS in 11m 05s
✔️ build-ansible-collection SUCCESS in 8m 03s
✔️ ansible-galaxy-importer SUCCESS in 5m 21s

@softwarefactory-project-zuul softwarefactory-project-zuul bot merged commit 54fa055 into ansible-collections:main Mar 14, 2024
13 checks passed
@mariolenz mariolenz deleted the 20240313-fix_ci branch March 14, 2024 16:33
mariolenz added a commit to mariolenz/community.vmware that referenced this pull request Mar 14, 2024
Drop Scenario Guides

SUMMARY
Those scenario guides are pretty outdated, most of them 3 years old. I think it's better to remove them instead of keeping outdated documentation.
ISSUE TYPE

Docs Pull Request

Reviewed-by: Sandra McCann <samccann@redhat.com>
Reviewed-by: Alexander Nikitin <ihumster@ihumster.ru>
softwarefactory-project-zuul bot pushed a commit that referenced this pull request Mar 14, 2024
Drop Scenario Guides (#2022)

SUMMARY
Those scenario guides are pretty outdated, most of them 3 years old. I think it's better to remove them instead of keeping outdated documentation.
ISSUE TYPE

Docs Pull Request

ADDITIONAL INFORMATION
Backport of #2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation mergeit
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants