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

fix/grass version numbers #318

Merged
merged 8 commits into from Sep 1, 2022
Merged

fix/grass version numbers #318

merged 8 commits into from Sep 1, 2022

Conversation

nobeeakon
Copy link
Collaborator

fixes

#315

what

Grass version numbers (current, legacy, preview) passed to /data folder so it can be a single source of truth and used in multiple places. Using shortcode so it can be used inside markdown files

Updated current version man pages links.

Copy link
Member

@wenzeslaus wenzeslaus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great. This seems to simplify the release procedure (which now even misses some of the website update steps).

<span class="mwl"><a href="/grass80/manuals/index.html " target="_blank"> GRASS GIS 8.0 (current) </a></span>
<a href="/grass80/manuals/index.html" class="inl btn btn-primary" target="_blank">View HTML</a> <a href="/grass80/manuals/grass-8.0_html_manual.zip" class="inl btn btn-secondary">Download ZIP</a>
<span class="mwl"><a href="/grass82/manuals/index.html " target="_blank"> GRASS GIS {{< grassVersion version="current" type="short">}} (current) </a></span>
<a href="/grass82/manuals/index.html" class="inl btn btn-primary" target="_blank">View HTML</a> <a href="/grass82/manuals/grass-8.2_html_manual.zip" class="inl btn btn-secondary">Download ZIP</a>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can the URLs be driven by the variables, too? 8.2 is already there. 82 can be perhaps another variable. There are two there already, so this would be a third one. (Ultimately, it seems to me that the URLs is what needs to be fixed, i.e., there should be 8.2 as elsewhere.)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(Ultimately, it seems to me that the URLs is what needs to be fixed, i.e., there should be 8.2 as elsewhere.)

While I agree that URLs should be changed to be based on variables as well, I humbly disagree that they should include periods. Myriads of documents refer to GRASS GIS versions without dots, and breaking with the URL style after decades doesn't seem very useful to me.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@wenzeslaus , I've added the 82 to the variables and used in the links and stuff. Kept them as they were.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(Ultimately, it seems to me that the URLs is what needs to be fixed, i.e., there should be 8.2 as elsewhere.)

...Myriads of documents refer to GRASS GIS versions without dots, and breaking with the URL style after decades doesn't seem very useful to me.

Out of scope for this PR, but would that be actually a problem? If they need to be updated, what is the difference between changing from 82 to 83 and changing from 82 to 8.3? If they don't need to be updated, keeping the old URL is enough to keep the old thing working. If you would still need URLs from both the new and old system, there is likely no issue mixing both because you need to specify all numbers explicitly anyway like for the variables in this PR.

10.0 seems more clear than 100. 8.11 is definitively more clear than 811. I think using dots everywhere is more predictable overall because it is consistent for all numbers within one version, while leaving out the dots leads to inconsistent numbers within one version (although being consistent across versions). However, clarity is anyway likely more important than consistency.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Out of scope for this PR, but would that be actually a problem?

Please, let's move this discussion to grass-dev as I would like to hear more voices here. In this repo it is too much hidden.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Out of scope for this PR, but would that be actually a problem? If they need to be updated, what is the difference between changing from 82 to 83 and changing from 82 to 8.3?

I'd agree with Vaclav. Although it can be discussed on -dev ML,

  1. somebody must make a post there;
  2. there must be a short deadline to not delay this PR forever.

neteler added a commit to neteler/grass-website that referenced this pull request Aug 9, 2022
Apparently the use of `grass-stable/` and `grass-devel/` penalizes the new GRASS GIS 8 versions over G78 in common search engines.
Reason may be that they are only redirects which cannot be easily ranked.

This PR brings back the GRASS GIS version in the manual URLs (followup to OSGeo#230) and to be considered in OSGeo#318.
neteler added a commit that referenced this pull request Aug 10, 2022
Apparently the use of `grass-stable/` and `grass-devel/` penalizes the new GRASS GIS 8 versions over G78 in common search engines.
Reason may be that they are only redirects which cannot be easily ranked.

This PR brings back the GRASS GIS version in the manual URLs (followup to #230) and to be considered in #318.
@neteler
Copy link
Member

neteler commented Aug 10, 2022

@nobeeakon Would you mind to also add

<loc>https://grass.osgeo.org/grass82/manuals/sitemap_manuals.xml</loc>

? Thanks.

@nobeeakon
Copy link
Collaborator Author

@neteler , had to create a new sitemap.xml file to be able to use the values stored in the data. Not sure how this impacts other stuff or if any additional change would be required for this new xml to be used instead of the other one as it is located in a different place

@neteler
Copy link
Member

neteler commented Aug 27, 2022

Mhh, the "donate popup" PR now conflicted with this one... @nobeeakon would you mind to rebase this PR?

@nobeeakon
Copy link
Collaborator Author

fixed @neteler

@neteler
Copy link
Member

neteler commented Aug 30, 2022

Thanks for the re-sync.

Will then this sitemap still exist (pointing to the "sub-sitemaps")?
https://grass.osgeo.org/sitemap.xml

@nobeeakon
Copy link
Collaborator Author

@neteler , fixed, now the sitemap is located in the same place as before

Copy link
Member

@neteler neteler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work!
Now only data/grass.json needs to be updated in future.

@neteler
Copy link
Member

neteler commented Sep 1, 2022

I suggest to merge this PR!

@veroandreo
Copy link
Contributor

I suggest to merge this PR!

I agree, please go ahead :)

@neteler neteler merged commit 11d0075 into OSGeo:master Sep 1, 2022
@neteler neteler mentioned this pull request Sep 1, 2022
@nobeeakon nobeeakon deleted the issue315 branch September 2, 2022 01:38
neteler added a commit to OSGeo/grass-addons that referenced this pull request Sep 9, 2022
@neteler
Copy link
Member

neteler commented Jan 24, 2023

@nobeeakon Today I enjoyed updating the GRASS GIS version to 8.2.1 on the website by simply editing data/grass.json. A big thank to you!

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

Successfully merging this pull request may close these issues.

None yet

5 participants