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

Better link or document the proper version in MapStore Documentation in home page #9600

Closed
offtherailz opened this issue Oct 16, 2023 · 3 comments · Fixed by #9705 or #9714
Closed

Better link or document the proper version in MapStore Documentation in home page #9600

offtherailz opened this issue Oct 16, 2023 · 3 comments · Fixed by #9705 or #9714
Assignees
@dsuren1 @ElenaGallo
Labels
Accepted Documentation enhancement
Milestone
2023.02.01

Comments

@offtherailz
Copy link
Member

offtherailz commented Oct 16, 2023 •
edited by tdipisa
Loading

Description

The home page of MapStore points always to latest documentation of MapStore.

image

In order to make clear to the users what version of the documentation to use we should do one of the following:

  • Change the link accordingly for each release
  • Clarify in the home page (Documentation section) how to get the proper version of the documentation accordingly to the owned version.
@tdipisa tdipisa assigned offtherailz and unassigned tdipisa Oct 16, 2023
@tdipisa tdipisa added this to the 2023.02.01 milestone Oct 16, 2023
@offtherailz offtherailz changed the title Better link or proper document the proper version in MapStore Better link or document the proper version in MapStore Oct 16, 2023
@offtherailz offtherailz changed the title Better link or document the proper version in MapStore Better link or document the proper version in MapStore Documentation in home page Oct 16, 2023
@tdipisa tdipisa assigned dsuren1 and unassigned offtherailz Nov 3, 2023
@dsuren1
Copy link
Contributor

dsuren1 commented Nov 14, 2023 •
edited
Loading

@offtherailz Kindly clarify.

Change the link accordingly for each release

To change the default link to point the version released. We can do it from admin console of readthedocs. Kindly correct me if this is not what is expected in the issue. Thanks!
image

@tdipisa
Copy link
Member

tdipisa commented Nov 14, 2023

@dsuren1 I've updated the description to clarify what is requested here.

@dsuren1
Copy link
Contributor

dsuren1 commented Nov 15, 2023

@tdipisa

Updated acceptance criteria

  • Update release procedure to include steps to modify readthedocs's advanced settings to point to the version released, so documentation by default loads the version configured
  • Update the documentation url to point the root of the url (https://docs.mapstore.geosolutionsgroup.com)

dsuren1 added a commit to dsuren1/MapStore2 that referenced this issue Nov 15, 2023
@dsuren1
geosolutions-it#9600 - Link release version in MapStore Documentation…
1991e10 
… in home page
@dsuren1 dsuren1 mentioned this issue Nov 15, 2023
Merged
4 tasks
@dsuren1 dsuren1 linked a pull request Nov 15, 2023 that will close this issue
#9600 - Link release version in MapStore Documentation in home page #9705
Merged
4 tasks
offtherailz pushed a commit that referenced this issue Nov 16, 2023
@dsuren1
#9600 - Link release version in MapStore Documentation in home page (#…
b34aaab 
…9705)
@ElenaGallo ElenaGallo added the BackportNeeded Commits provided for an issue need to be backported to the milestone's stable branch label Nov 16, 2023
@ElenaGallo ElenaGallo self-assigned this Nov 17, 2023
dsuren1 added a commit to dsuren1/MapStore2 that referenced this issue Nov 17, 2023
@dsuren1
geosolutions-it#9600 - Link release version in MapStore Documentation…
dd46a19 
… in home page (geosolutions-it#9705)

(cherry picked from commit b34aaab)
@dsuren1 dsuren1 mentioned this issue Nov 17, 2023
Merged
@dsuren1 dsuren1 linked a pull request Nov 17, 2023 that will close this issue
[Backport 2023.02.xx] #9600 - Link release version in MapStore Documentation in home page (#9705) #9714
Merged
offtherailz pushed a commit that referenced this issue Nov 20, 2023
@dsuren1
#9600 - Link release version in MapStore Documentation in home page (#…
4f230cb 
…9705) (#9714)

(cherry picked from commit b34aaab)
@ElenaGallo ElenaGallo added Accepted and removed BackportNeeded Commits provided for an issue need to be backported to the milestone's stable branch labels Nov 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dsuren1 dsuren1

@ElenaGallo ElenaGallo

Labels
Accepted Documentation enhancement
Projects
None yet
Milestone
2023.02.01
4 participants
@offtherailz @tdipisa @dsuren1 @ElenaGallo