# Removing old/stale scenario guides

**URL:** <https://forum.ansible.com/t/removing-old-stale-scenario-guides/2761>\
**Category:** Project Discussions\
**Tags:** documentation, collections\
**Created:** [December 5, 2023, 7:08pm UTC](https://forum.ansible.com/t/removing-old-stale-scenario-guides/2761 "2023-12-05T19:08:00Z")\
**Posts on this page:** 20\
**Page:** 1

<div class="post-metadata">

**Author:** ![samccann](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/samccann/32/18_2.png) [@samccann](https://forum.ansible.com/u/samccann)\
**Post date:** [December 5, 2023, 7:08pm UTC](https://forum.ansible.com/t/removing-old-stale-scenario-guides/2761/1 "2023-12-05T19:08:00Z")

</div>

We’ve had scenario guides on [the main documentation](https://docs.ansible.com/ansible/latest/index.html) for some time now, but many of them are unmaintained. Three already moved to their respective collections, but we have 13 more that are just lingering in the following categories:

 ![image](https://us1.discourse-cdn.com/ansible/original/2X/6/68208b02f941eba3acc50ee9c495435e29cf016d.png)

I’m proposing the following:

1. Open an issue in the collection related to the scenario guide to ask them to move the content into their collection. Let them know the stale content will be removed in Ansible 10.
2. Remove them all in `devel` branch and replace with a stub page that either points to the new location within the collection, or the collection issue we created above so readers know where to go for feedback etc. This sets us up for their removal when Ansible 10 releases.

Since we’re creating all the collection-level issues, we’ll know if the content has been moved and can update the stub with the correct pointer to the new location.

This has the benefit of removing stale documentation and hopefully convincing collection owners to take this content over and update it to match their updated collection.

Would welcome feedback on this idea before we implement it.

---

<div class="post-metadata">

**Author:** ![mariolenz](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/mariolenz/32/108_2.png) [@mariolenz](https://forum.ansible.com/u/mariolenz)\
**Post date:** [December 5, 2023, 7:58pm UTC](https://forum.ansible.com/t/removing-old-stale-scenario-guides/2761/2 "2023-12-05T19:58:16Z")

</div>

Is there a difference between collections that are included in the community package and those that are not?

What I mean is: Can we get rid of scenario guides for collections that are not part of Ansible 9 easier?

BTW `vmware.vmware_rest` seems to have the [scenario guides](https://github.com/ansible-collections/vmware.vmware_rest/tree/main/docs/docsite/rst/vmware_rest_scenarios) in the collection repository. But the [official documentation](https://docs.ansible.com/ansible/latest/scenario_guides/guide_vmware_rest.html) looks weird. Shouldn’t this be a link to [Scenario Guide](https://docs.ansible.com/ansible/latest/collections/vmware/vmware_rest/index.html#scenario-guide) or [VMware Guide (REST)](https://docs.ansible.com/ansible/latest/collections/vmware/vmware_rest/docsite/guide_vmware_rest.html)?

---

<div class="post-metadata">

**Author:** ![samccann](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/samccann/32/18_2.png) [@samccann](https://forum.ansible.com/u/samccann)\
**Post date:** [December 6, 2023, 8:12pm UTC](https://forum.ansible.com/t/removing-old-stale-scenario-guides/2761/3 "2023-12-06T20:12:06Z")

</div>

I agree that if it isn’t in the package, it should be removed (scenario guide). As for `vmware.vmware_rest` - looks like the :ref: is busted on that page. It should link to the latter above.

---

<div class="post-metadata">

**Author:** ![felixfontein](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/felixfontein/32/7530_2.png) [@felixfontein](https://forum.ansible.com/u/felixfontein)\
**Post date:** [December 7, 2023, 12:07pm UTC](https://forum.ansible.com/t/removing-old-stale-scenario-guides/2761/4 "2023-12-07T12:07:25Z")

</div>

> [@samccann](#):
>
> Open an issue in the collection related to the scenario guide to ask them to move the content into their collection.

Didn’t we do that once?

In any case, 👍 for getting rid of the ones still there!

---

<div class="post-metadata">

**Author:** ![samccann](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/samccann/32/18_2.png) [@samccann](https://forum.ansible.com/u/samccann)\
**Post date:** [December 7, 2023, 8:50pm UTC](https://forum.ansible.com/t/removing-old-stale-scenario-guides/2761/5 "2023-12-07T20:50:56Z")

</div>

Yes we did and some of them got ignored. I will check to see if there is an issue already before creating a new one. I saw one that was not only ignored, but they also ignored a PR someone here did for them to move it. so 🤷🏻

---

<div class="post-metadata">

**Author:** ![felixfontein](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/felixfontein/32/7530_2.png) [@felixfontein](https://forum.ansible.com/u/felixfontein)\
**Post date:** [December 7, 2023, 10:00pm UTC](https://forum.ansible.com/t/removing-old-stale-scenario-guides/2761/6 "2023-12-07T22:00:15Z")

</div>

> [@samccann](#):
>
> I saw one that was not only ignored, but they also ignored a PR someone here did for them to move it. so 🤷🏻

That’s _really_ sad!

---

<div class="post-metadata">

**Author:** ![mariolenz](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/mariolenz/32/108_2.png) [@mariolenz](https://forum.ansible.com/u/mariolenz)\
**Post date:** [December 9, 2023, 1:34pm UTC](https://forum.ansible.com/t/removing-old-stale-scenario-guides/2761/7 "2023-12-09T13:34:23Z")

</div>

> [@samccann](#):
>
> I agree that if it isn’t in the package, it should be removed (scenario guide).

In that case… these scenario guides seem to be about collections that are not part of the Ansible community package:

- [Alibaba Cloud Compute Services Guide](https://docs.ansible.com/ansible/latest/scenario_guides/guide_alicloud.html) (alibaba.alicloud)
- [Google Cloud Platform Guide](https://docs.ansible.com/ansible/latest/scenario_guides/guide_gce.html) (google.cloud)
- [Oracle Cloud Infrastructure Guide](https://docs.ansible.com/ansible/latest/scenario_guides/guide_oracle.html) (oracle.oci\_ansible\_modules)

Please check if I’m right. If I am, I’d say just remove them completely.

> [@samccann](#):
>
> As for `vmware.vmware_rest` - looks like the :ref: is busted on that page. It should link to the latter above.

Should I try to fix this, or do you prefer to remove the VMware REST Scenarios completely? Since the link is broken (and probably has been for some time) I tend to remove it.

@felixfontein [Packet.net Guide](https://docs.ansible.com/ansible/latest/scenario_guides/guide_packet.html), [Rackspace Cloud Guide](https://docs.ansible.com/ansible/latest/scenario_guides/guide_rax.html) and [Scaleway Guide](https://docs.ansible.com/ansible/latest/scenario_guides/guide_scaleway.html) seem to be about modules that are now in `community.general`. Could you please have a look and check if I’m right? And, if I am, think about what we should do with them?

@samccann Your proposal sounds reasonable, but I think these scenario guides are low hanging fruit and we can do something about them pretty easily. And then we can think what to do with the rest.

---

<div class="post-metadata">

**Author:** ![felixfontein](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/felixfontein/32/7530_2.png) [@felixfontein](https://forum.ansible.com/u/felixfontein)\
**Post date:** [December 9, 2023, 2:21pm UTC](https://forum.ansible.com/t/removing-old-stale-scenario-guides/2761/8 "2023-12-09T14:21:01Z")

</div>

> [@mariolenz](#):
>
> - [Alibaba Cloud Compute Services Guide](https://docs.ansible.com/ansible/latest/scenario_guides/guide_alicloud.html) (alibaba.alicloud)

This one is strange. It doesn’t mention any collection, and two of the three modules mentioned have never been part of Ansible, while the third is part of community.general.

I would recommend to delete that guide, as it contains incorrect information.

> [@mariolenz](#):
>
> - [Google Cloud Platform Guide](https://docs.ansible.com/ansible/latest/scenario_guides/guide_gce.html) (google.cloud)

That collection was part of Ansible, but got removed. The guide should be moved there, assuming it is still relevant. If it is no longer relevant, it should be removed.

> [@mariolenz](#):
>
> - [Oracle Cloud Infrastructure Guide](https://docs.ansible.com/ansible/latest/scenario_guides/guide_oracle.html) (oracle.oci\_ansible\_modules)

This one belongs to `oracle.oci_ansible_modules` and should be part of that collection.

> [@mariolenz](#):
>
> @felixfontein [Packet.net Guide](https://docs.ansible.com/ansible/latest/scenario_guides/guide_packet.html), [Rackspace Cloud Guide](https://docs.ansible.com/ansible/latest/scenario_guides/guide_rax.html) and [Scaleway Guide](https://docs.ansible.com/ansible/latest/scenario_guides/guide_scaleway.html) seem to be about modules that are now in `community.general`. Could you please have a look and check if I’m right? And, if I am, think about what we should do with them?

I guess it makes sense to move them to community.general, but they clearly need an overhaul. They mention dynamic inventory scripts, for example, that are now in [GitHub - ansible-community/contrib-scripts: Old Ansible inventory & vault scripts](https://github.com/ansible-community/contrib-scripts/).

The Rackspace modules are currently deprecated in community.general since the Python library they use is deprecated. They will be removed in the next major community.general release. It’s probably best to simply delete that scenario guide.

---

<div class="post-metadata">

**Author:** ![mariolenz](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/mariolenz/32/108_2.png) [@mariolenz](https://forum.ansible.com/u/mariolenz)\
**Post date:** [December 9, 2023, 3:37pm UTC](https://forum.ansible.com/t/removing-old-stale-scenario-guides/2761/9 "2023-12-09T15:37:05Z")

</div>

> [@felixfontein](#):
>
> > [@mariolenz](#):
> >
> > - [Google Cloud Platform Guide](https://docs.ansible.com/ansible/latest/scenario_guides/guide_gce.html) (google.cloud)
> 
> That collection was part of Ansible, but got removed. The guide should be moved there, assuming it is still relevant. If it is no longer relevant, it should be removed.

Looks like I was wrong there, `google.cloud` is still [part of the package](https://github.com/ansible-community/ansible-build-data/blob/61810bbda59a59918295c307ba3993f39e2e100b/9/ansible-9.1.0.deps#L65). We’ve [canceled the removal](https://github.com/ansible-community/community-topics/discussions/195).

---

<div class="post-metadata">

**Author:** ![felixfontein](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/felixfontein/32/7530_2.png) [@felixfontein](https://forum.ansible.com/u/felixfontein)\
**Post date:** [December 9, 2023, 9:26pm UTC](https://forum.ansible.com/t/removing-old-stale-scenario-guides/2761/10 "2023-12-09T21:26:46Z")

</div>

Oh right, we cancelled the removal. But in any case, it should be moved to the collection, and removed from [github.com/ansible-community/ansible-documentation](http://github.com/ansible-community/ansible-documentation).

---

<div class="post-metadata">

**Author:** ![mariolenz](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/mariolenz/32/108_2.png) [@mariolenz](https://forum.ansible.com/u/mariolenz)\
**Post date:** [December 10, 2023, 12:29pm UTC](https://forum.ansible.com/t/removing-old-stale-scenario-guides/2761/11 "2023-12-10T12:29:36Z")

</div>

@felixfontein I’ve created [PR 965](https://github.com/ansible/ansible-documentation/pull/965) for a start. Let’s see what @samccann thinks about it.

---

<div class="post-metadata">

**Author:** ![felixfontein](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/felixfontein/32/7530_2.png) [@felixfontein](https://forum.ansible.com/u/felixfontein)\
**Post date:** [December 10, 2023, 1:21pm UTC](https://forum.ansible.com/t/removing-old-stale-scenario-guides/2761/12 "2023-12-10T13:21:03Z")

</div>

The Alicloud guide already got moved here: [https://github.com/alibaba/alibaba.alicloud/blob/master/docs/docsite/rst/guide\_alicloud.rst](https://github.com/alibaba/alibaba.alicloud/blob/master/docs/docsite/rst/guide_alicloud.rst) That collection doesn’t seem to exist on Galaxy though.

I’m currently adding another copy of it to community.general, since that collection still contains some modules.

---

<div class="post-metadata">

**Author:** ![felixfontein](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/felixfontein/32/7530_2.png) [@felixfontein](https://forum.ansible.com/u/felixfontein)\
**Post date:** [December 10, 2023, 1:25pm UTC](https://forum.ansible.com/t/removing-old-stale-scenario-guides/2761/13 "2023-12-10T13:25:44Z")

</div>

PR: [Add Alicloud, Packet, and Scaleway scenario guides by felixfontein · Pull Request #7714 · ansible-collections/community.general · GitHub](https://github.com/ansible-collections/community.general/pull/7714)

---

<div class="post-metadata">

**Author:** ![mariolenz](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/mariolenz/32/108_2.png) [@mariolenz](https://forum.ansible.com/u/mariolenz)\
**Post date:** [December 10, 2023, 2:31pm UTC](https://forum.ansible.com/t/removing-old-stale-scenario-guides/2761/14 "2023-12-10T14:31:55Z")

</div>

[Add stubs for moved scenario guides](https://github.com/ansible/ansible-documentation/pull/965#issuecomment-1848981146)

---

<div class="post-metadata">

**Author:** ![mariolenz](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/mariolenz/32/108_2.png) [@mariolenz](https://forum.ansible.com/u/mariolenz)\
**Post date:** [December 10, 2023, 3:08pm UTC](https://forum.ansible.com/t/removing-old-stale-scenario-guides/2761/15 "2023-12-10T15:08:03Z")

</div>

> [@felixfontein](#):
>
> > [@mariolenz](#):
> >
> > - [Oracle Cloud Infrastructure Guide](https://docs.ansible.com/ansible/latest/scenario_guides/guide_oracle.html) (oracle.oci\_ansible\_modules)
> 
> This one belongs to `oracle.oci_ansible_modules` and should be part of that collection.

True, but I don’t think we should wait on them moving the guide to their collection. However, I’ve opened [an issue](https://github.com/oracle/oci-ansible-collection/issues/262) in their repo to inform them.

But since this collection isn’t part of the ansible package, I think we should just remove the scenario guide.

Anyway, they’re informed now and can move it to their collection if they want.

---

<div class="post-metadata">

**Author:** ![felixfontein](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/felixfontein/32/7530_2.png) [@felixfontein](https://forum.ansible.com/u/felixfontein)\
**Post date:** [December 10, 2023, 4:55pm UTC](https://forum.ansible.com/t/removing-old-stale-scenario-guides/2761/16 "2023-12-10T16:55:02Z")

</div>

I just noticed that the [Online guide](https://docs.ansible.com/ansible/latest/scenario_guides/guide_online.html) also belongs into community.general since the Online modules and inventory plugin live there. I’ve added it to [Add Alicloud, Packet, and Scaleway scenario guides by felixfontein · Pull Request #7714 · ansible-collections/community.general · GitHub](https://github.com/ansible-collections/community.general/pull/7714).

---

<div class="post-metadata">

**Author:** ![mariolenz](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/mariolenz/32/108_2.png) [@mariolenz](https://forum.ansible.com/u/mariolenz)\
**Post date:** [December 10, 2023, 5:20pm UTC](https://forum.ansible.com/t/removing-old-stale-scenario-guides/2761/17 "2023-12-10T17:20:08Z")

</div>

> [@felixfontein](#):
>
> I just noticed that the [Online guide](https://docs.ansible.com/ansible/latest/scenario_guides/guide_online.html) also belongs into community.general since the Online modules and inventory plugin live there. I’ve added it to [Add Alicloud, Packet, and Scaleway scenario guides by felixfontein · Pull Request #7714 · ansible-collections/community.general · GitHub](https://github.com/ansible-collections/community.general/pull/7714).

[Add Online.net Guide stub](https://github.com/ansible/ansible-documentation/pull/965/commits/9ec0df0f1375e787f59e1716fcf7b37bfdc6c876)

---

<div class="post-metadata">

**Author:** ![samccann](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/samccann/32/18_2.png) [@samccann](https://forum.ansible.com/u/samccann)\
**Post date:** [December 11, 2023, 4:47pm UTC](https://forum.ansible.com/t/removing-old-stale-scenario-guides/2761/18 "2023-12-11T16:47:26Z")

</div>

Thanks @mariolenz and @felixfontein this is great!

My one question - on the PR that removes the guides (or adds stub pages). My initial thought was that only goes into devel, but that means for the guides @felixfontein is revamping in community.general - users won’t see that until Ansible 10. Is that okay or should we separate the ‘delete now’ guides from the ‘stub pages to new location’ guides? The latter could be backported to stable-2.16 and available in Ansible 9 on the next community.general release that picks up the new guides.

I personally think we can just keep all the changes in devel and they would become /latest/ with Ansible 10, but figured I’d ask.

---

<div class="post-metadata">

**Author:** ![samccann](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/samccann/32/18_2.png) [@samccann](https://forum.ansible.com/u/samccann)\
**Post date:** [December 11, 2023, 5:04pm UTC](https://forum.ansible.com/t/removing-old-stale-scenario-guides/2761/19 "2023-12-11T17:04:25Z")

</div>

I created [Remove/relocate stale scenario guides · Issue #969 · ansible/ansible-documentation · GitHub](https://github.com/ansible/ansible-documentation/issues/969) to track all the moves/removals. I’ll update that now with the two PRs mentioned here (for removal and the moves to community.general).

---

<div class="post-metadata">

**Author:** ![mariolenz](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/mariolenz/32/108_2.png) [@mariolenz](https://forum.ansible.com/u/mariolenz)\
**Post date:** [December 11, 2023, 5:10pm UTC](https://forum.ansible.com/t/removing-old-stale-scenario-guides/2761/20 "2023-12-11T17:10:15Z")

</div>

> [@samccann](#):
>
> My initial thought was that only goes into devel, but that means for the guides @felixfontein is revamping in community.general - users won’t see that until Ansible 10. Is that okay or should we separate the ‘delete now’ guides from the ‘stub pages to new location’ guides? The latter could be backported to stable-2.16 and available in Ansible 9 on the next community.general release that picks up the new guides.

I tend to keep it simple and only remove the scenario guides from devel, even if it means that the stub pages linking to the new locations won’t show up until Ansible 10.

But I’m open to split my PR into two new ones if you think it better.

[Next page](https://forum.ansible.com/t/removing-old-stale-scenario-guides/2761.md?page=2)
