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

docs: Confusion with stable-0.x docs #580

Open
superstes opened this issue Jan 10, 2025 · 1 comment
Open

docs: Confusion with stable-0.x docs #580

superstes opened this issue Jan 10, 2025 · 1 comment

Comments

@superstes
Copy link

superstes commented Jan 10, 2025

What is the issue ?

When users search ansible ara configuration in search-engines like Google - only the old stable-0.x documentation shows up: https://ara.readthedocs.io/en/stable-0.x/configuration.html

This can be very confusing to new users as these config-settings do partially not work with the latest version.
Example: ignore_facts vs ignored_facts

What should be happening ?

Is the old documentation still relevant? As far as I see the old branch has not had changes since 5 years.
Maybe just delete that old documentation-revision?
Or put a yellow banner on top to inform users that this is not the documentation for the latest version?

Also: Maybe add a keyword like ARA client configuration to the current configuration page so it gets picked-up easier by search-engines: https://ara.readthedocs.io/en/latest/ansible-plugins-and-use-cases.html

@dmsimard
Copy link
Contributor

Hi and thanks for the issue.

I understand the sentiment though until somewhat recently there were still users of 0.x out there.
It would be fair to retire it by now, they have long diverged and I haven't supported 0.x in a long time.

I'll leave this issue up and we can take care of it.
I have no control over the SEO and search engine results though :p

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants