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-6703] Docs should point to correct version number #618

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

aitseitz
Copy link
Contributor

@aitseitz aitseitz commented Apr 7, 2022

Hi,

I've posted this documention suggestion on the official alfresco discord server and as told by @aborroy I'm therefore opening this ticket:


In my acs ansible tasks or in other source code I'm writing for the customer, I'm always referencing to the official documentation pages.
For example, for an ACS 6.2 ansible task, I'm referencing to
https://docs.alfresco.com/content-services/6.2/install/zip/tomcat/#install-alfresco-wars

For the current ACS 7.2 version I can only reference to:
https://docs.alfresco.com/content-services/latest/install/zip/tomcat/#install-alfresco-wars

What I would like to reference in my sourcecode is:
https://docs.alfresco.com/content-services/7.2/install/zip/tomcat/#install-alfresco-wars
so I don't have to adjust my commits once the next ACS version 7.3 is out...

This Issue is not only related to ACS, it's a general topic for all alfresco services documentations.
Is it somehow possible to upload/reference the latest documentation as well for the specific version number?

I've also realized alfresco itself runs into this issue with all it's release notes!

For Example:
Release Notes form ACS 7.1 sadly does not point to its correct documentation:
https://docs.alfresco.com/content-services/7.1/
image

Release Notes from ACS 7.0 sadly does not point to its correct documentation:
https://docs.alfresco.com/content-services/7.0/
image

and so on....

Hi,

I've posted this documantion suggestion on the official alfresco discord server and as told by @aborroy  I'm therefore opening this ticket:

----

In my acs ansible tasks or in other source code I'm writing for the customer, I'm always referencing to the official documentation pages. 
For example, for an ACS 6.2 ansible task, I'm referencing to
https://docs.alfresco.com/content-services/6.2/install/zip/tomcat/#install-alfresco-wars

For the current ACS 7.2 version I can only reference to:
https://docs.alfresco.com/content-services/latest/install/zip/tomcat/#install-alfresco-wars

What I would like to reference in my sourcecode is:
https://docs.alfresco.com/content-services/7.2/install/zip/tomcat/#install-alfresco-wars
so I don't have to adjust my commits once the next ACS version 7.3 is out...

This Issue is not only related to ACS, it's a general topic for all alfresco services documentations.
Is it somehow possible to upload/reference the latest documentation as well for the specific version number?
@aitseitz aitseitz requested a review from a team as a code owner April 7, 2022 12:27
@aitseitz
Copy link
Contributor Author

aitseitz commented Apr 7, 2022

@anxumalo @aborroy
I opened the discord topic for the case with this pullrequest
#618

The commit is more a dummy commit to open the topic. You have to evaluate it internally and how you want handle this now and in the near future, as well as in regards of the upcomming acs naming sheme. I can't fix it for you, cause there is more to the topic then just provide a 7.2 copy from the latest docs....SEO and SEM must be evaluated as well, so that new and old documentations does never link to a 404 page.

One Solution could be done via Proxy settings so that
https://docs.alfresco.com/content-services/latest/
always redirects to the latest acs version, which currently is
https://docs.alfresco.com/content-services/7.2/

@anxumalo
Copy link
Contributor

anxumalo commented Jun 1, 2022

Thanks for your feedback and for your patience. We really appreciate the time that you have taken to let us know what you think.

We've taken note of your suggestions and will discuss the required changes with the relevant teams. As you can appreciate, it's not an easy fix and may take some time. This is tracked internally as DOCS-6703.

@anxumalo anxumalo self-assigned this Jun 1, 2022
@anxumalo
Copy link
Contributor

anxumalo commented Sep 2, 2022

Hi @aitseitz, there have been some related updates applied to the Alfresco Docs site. Although this work doesn't fully address the issue you reported (i.e. provide Docs that point to the exact version number), we’ve implemented redirects that reduce the number of Docs links that result in 404 pages from our software, for example, from the Admin Console.

If you find any links that may have been missed, please feel free to report them in a new PR. Many thanks

@oliveralfresco2018 oliveralfresco2018 changed the title Docs should point to correct version number [DOCS-6703] Docs should point to correct version number Oct 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants