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.

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

Remove docs and examples directories #81011

Merged
merged 10 commits into from
Jul 11, 2023
Merged

Remove docs and examples directories #81011

merged 10 commits into from
Jul 11, 2023

Conversation

mattclay
Copy link
Member

@mattclay mattclay commented Jun 9, 2023 •
edited

SUMMARY

Remove docs and examples directories.

Also remove hacking/build_library/ and hacking/build-ansible.py, which are now obsolete with the removal of docs.

ISSUE TYPE

Docs Pull Request

COMPONENT NAME

docs

@ansibot
Copy link
Contributor

ansibot commented Jun 9, 2023

@mattclay This PR was evaluated as a potentially problematic PR for the following reasons:

  • More than 50 changed files.

Such PR can only be merged by human. Contact a Core team member to review this PR on IRC: #ansible-devel on Libera.chat IRC

click here for bot help

@ansibot ansibot added WIP This issue/PR is a work in progress. Nevertheless it was shared for getting input from peers. affects_2.16 docs This issue/PR relates to or includes documentation. needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html needs_triage Needs a first human triage before being processed. labels Jun 9, 2023
@mattclay mattclay removed the needs_triage Needs a first human triage before being processed. label Jun 9, 2023
@mattclay mattclay changed the title Experiment with removal of docs directory Remove docs and examples directories Jun 22, 2023
@oraNod oraNod mentioned this pull request Jul 4, 2023
Closed
@mattclay mattclay mentioned this pull request Jul 10, 2023
Merged
samccann
samccann approved these changes Jul 11, 2023
View reviewed changes
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.

DaWGs meeting agrees we are ready to go with this. Thanks

@mattclay mattclay mentioned this pull request Jul 11, 2023
Merged
@mattclay mattclay marked this pull request as ready for review July 11, 2023 19:39
@mattclay mattclay requested a review from a team as a code owner July 11, 2023 19:39
@mattclay mattclay merged commit 72e038e into ansible:devel Jul 11, 2023
84 checks passed
@mattclay mattclay deleted the no-docs-dir branch July 11, 2023 19:40
mattclay added a commit to mattclay/ansible that referenced this pull request Jul 12, 2023
@mattclay
[stable-2.15] Remove docs and examples directories (ansible#81011)
d1b196d 
* Remove docs dir

* Updates to reflect docs removal

* Fix integration test

* Remove examples dir

* Updates to reflect examples removal

* Remove build_library and build-ansible.py

* Remove refs to build_library and build-ansible.py

* Remove obsolete template

* Remove obsolete template reference

* Remove the now obsolete rstcheck sanity test.
(cherry picked from commit 72e038e)

Co-authored-by: Matt Clay <matt@mystile.com>
@mattclay mattclay mentioned this pull request Jul 12, 2023
Merged
mattclay added a commit to mattclay/ansible that referenced this pull request Jul 12, 2023
@mattclay
[stable-2.15] Remove docs and examples directories (ansible#81011)
34ad7d2 
* Remove docs dir

* Updates to reflect docs removal

* Fix integration test

* Remove examples dir

* Updates to reflect examples removal

* Remove build_library and build-ansible.py

* Remove refs to build_library and build-ansible.py

* Remove obsolete template

* Remove obsolete template reference

* Remove the now obsolete rstcheck sanity test.
(cherry picked from commit 72e038e)

Co-authored-by: Matt Clay <matt@mystile.com>
@bartowl
Copy link

bartowl commented Jul 12, 2023

Please note, that there are a LOT of resources in Internet that references files like https://github.com/ansible/ansible/blob/devel/examples/scripts/ConfigureRemotingForAnsible.ps1

By removing examples you made them dead links!

@vijayreddiar
Copy link

This was shocking, we were referring this link for WinRM configuration and our automation started failing.

https://raw.githubusercontent.com/ansible/ansible/devel/examples/scripts/ConfigureRemotingForAnsible.ps1

@harrisonfoundry
Copy link

We need this too https://raw.githubusercontent.com/ansible/ansible/devel/examples/scripts/ConfigureRemotingForAnsible.ps1

@oraNod
Copy link
Contributor

oraNod commented Jul 12, 2023

Hi everyone. The examples folder has moved to https://github.com/ansible/ansible-documentation/tree/devel/examples

This change is part of a larger restructure of the Ansible community documentation. Our decision was to take the opportunity to move the examples when we created the ansible/ansible-documentation repository. This will give us the chance to review and improve this content on behalf of the community.

If you have a resource dependency, we recommend that you modify any urls that reference the devel branch to use a tested commit SHA. This will help avoid broken links.

For example, this url is 404: https://raw.githubusercontent.com/ansible/ansible/devel/examples/scripts/ConfigureRemotingForAnsible.ps1

You can update the url and replace devel with a SHA that you have tested, for example: https://raw.githubusercontent.com/ansible/ansible/38e50c9f819a045ea4d40068f83e78adbfaf2e68/examples/scripts/ConfigureRemotingForAnsible.ps1

If you would rather continue using the devel version of the resource, please modify any urls to use the new ansible/ansible-documentation repository. However, please keep in mind that future changes are likely to take place and urls might break again.

We would appreciate hearing more from you about how you use the examples. Please feel free to leave a comment in the GitHub issue to evaluate and simplify the examples folder.

For your reference, this is the Ansible community topic related to the new documentation repository: ansible-community/community-topics#243

@mkrizek mkrizek mentioned this pull request Jul 12, 2023
Closed
1 task
@keirazhang keirazhang mentioned this pull request Jul 13, 2023
Merged
@tremble tremble mentioned this pull request Jul 13, 2023
Open
1 task
@ansible ansible locked and limited conversation to collaborators Jul 18, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@samccann samccann samccann approved these changes

Assignees
No one assigned
Labels
affects_2.16 docs This issue/PR relates to or includes documentation. has_issue needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html WIP This issue/PR is a work in progress. Nevertheless it was shared for getting input from peers.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
7 participants
@mattclay @ansibot @bartowl @vijayreddiar @harrisonfoundry @oraNod @samccann