Make the download link on top in the installation guide #239
Conversation
WalkthroughThe recent changes to the installation guide involve enhancing user experience by adding and reordering reference links, updating package descriptions, and ensuring consistency in link names for improved clarity and accessibility. Changes
Possibly related issues
Poem
Warning Review ran into problemsProblems (1)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Out of diff range and nitpick comments (11)
content/resources/installation-guide/index.md (11)
19-19: Consider adding a brief description for the link to "The main installers page" to improve accessibility and SEO.
Line range hint
45-45: Simplify the language for clarity and conciseness.- The installer is able to install from internet or just download all needed packages beforehand. + The installer can install from the internet or download all needed packages beforehand.
Line range hint
51-51: Use a hyphen in "long-term release" when used as a compound adjective.- install the _long term release_. + install the _long-term release_.
Line range hint
98-98: Correct the grammatical error in the sentence.- you will need for this instructions: + you will need for these instructions:
Line range hint
160-160: Add a comma after "versions" for better readability.- For Ubuntu we also used to have extra packages in a separate repository that are based on + For Ubuntu, we also used to have extra packages in a separate repository that are based on
Line range hint
165-165: Add commas to improve the readability of the sentence.- the packages might sooner or later be broken for these targets, when the development in debian, ubuntu or ubuntugis-unstable moves on and their packages used as dependencies in qgis change. + the packages might, sooner or later, be broken for these targets, when the development in Debian, Ubuntu, or ubuntugis-unstable moves on and their packages used as dependencies in QGIS change.
Line range hint
171-171: Correct the verb form for consistency and correctness.- whose packages are rebuild on regular basis + whose packages are rebuilt on a regular basis
Line range hint
171-171: Correct the spelling of "pickup" to "pick up" when used as a verb.- and will also pickup the updated dependencies automatically + and will also pick up the updated dependencies automatically
Line range hint
407-407: Use a hyphen in "long-term release" when used as a compound adjective.- QGIS Long Term Release is available in AUR (Arch User Repository). + QGIS Long-Term Release is available in AUR (Arch User Repository).
Line range hint
463-463: Use a hyphen in "distro-agnostic" when used as a compound adjective.- Spack is a distro agnostic package manager for Linux, which is developed in the context of high-performance computing. + Spack is a distro-agnostic package manager for Linux, which is developed in the context of high-performance computing.
Line range hint
502-502: Use a hyphen in "long-term version" when used as a compound adjective.- and the long term version (port `qgis3-ltr`). + and the long-term version (port `qgis3-ltr`).
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- content/resources/installation-guide/index.md (2 hunks)
Additional Context Used
LanguageTool (41)
content/resources/installation-guide/index.md (41)
Near line 36: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...}) [Checksum]({{< param "lr_sha" >}})| |Long Term Release|{{< param "ltrrelease" >}} {{< ...
Near line 39: Possible missing comma found.
Context: ...alone installers. In the feature freeze phase that also acts as release candidate...
Near line 45: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...Python, GRASS, GDAL, etc. The installer is able to install from internet or just download ...
Near line 45: Possible missing comma found.
Context: ...re kept in a local directory for future installations and could also be used to install offli...
Near line 51: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ease_ and/or QGIS LTR to install the long term release. Alternatively to _Expre...
Near line 60: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...y build of the upcoming point release| |Long Term Release|{{< param "ltrrelease" >}} {{< ...
Near line 61: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...1]](#id1)|Nightly build of the upcoming long term point release| |Development|{{< param "...
Near line 70: Possible missing comma found.
Context: .... Before installing any of the nightly builds note the warning. # Linux ...
Near line 98: The singular determiner ‘this’ may not agree with the plural noun ‘instructions’. Did you mean “these”?
Context: ...st install some tools you will need for this instructions: ``` sudo apt install gnu...
Near line 160: It is considered good style to insert a comma after introductory phrases with dates or proper nouns.
Context: ... individual distributions provide. For Ubuntu we also used to have extra packages in ...
Near line 160: Possible missing comma found.
Context: ...tu itself for LTS versions. If you want those you also need to include ubuntugis-unst...
Near line 165: Consider adding two commas here.
Context: ... have library changes the packages might sooner or later be broken for these targets, when the d...
Near line 165: It appears that a comma is missing.
Context: ...as dependencies in qgis change. In that event you can either - move to a stable debi...
Near line 171: Consider using either the past participle “rebuilt” or the present participle “rebuilding” here.
Context: ...branches and master) whose packages are rebuild on regular basis and will also pickup t...
Near line 171: The word “pickup” is a noun. The verb is spelled with a space.
Context: ... rebuild on regular basis and will also pickup the updated dependencies automatically ...
Near line 186: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...org/ubuntugis-nightly-release | | | | Long Term Release Repository | {{< param "ltrvers...
Near line 234: Consider inserting a comma for improved readability.
Context: ...After you have verified the output you can install the key with:sudo mkd...
Near line 240: Consider adding a comma after ‘Alternatively’ for more clarity.
Context: .../keyrings/qgis-archive-keyring.gpg ``` Alternatively you can download the key directly witho...
Near line 248: Possible missing comma found.
Context: ...ve-keyring.gpg ``` With the keyring in place you can add the repository as `/etc/apt...
Near line 248: Possible missing article found.
Context: ...c/apt/sources.list.d/qgis.sources` with following content: ``` Types: deb deb-src URIs: ...
Near line 259: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...keyring.gpgExample for the latest long term release for Ubuntu 22.04 Jammy:Ty...
Near line 270: It appears that a comma is missing.
Context: ...gis-archive-keyring.gpg ``` After that type the commands below to install QGIS: ``...
Near line 288: Consider adding a comma here.
Context: ...t themeClass="coloring-1" >}} ##### Note Please remove all the QGIS and GRASS packages ...
Near line 313: Possible missing comma found.
Context: ...do dnf copr enable dani/qgis ``` After that type the commands below to install QGIS...
Near line 313: It appears that a comma is missing.
Context: ...f copr enable dani/qgis ``` After that type the commands below to install QGIS: ``...
Near line 332: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...oud.org/coprs/dani/qgis/ ### QGIS LTR (Long Term Release) Enable the repository: ``` s...
Near line 340: Possible missing comma found.
Context: ...nf copr enable dani/qgis-ltr ``` After that type the commands below to install QGIS...
Near line 340: It appears that a comma is missing.
Context: ...pr enable dani/qgis-ltr ``` After that type the commands below to install QGIS: ``...
Near line 407: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... pacman -S qgis ``` ### QGIS LTR QGIS Long Term Release is available in AUR (Arch User ...
Near line 457: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...eed to install additional Python modules, because they are needed by a plugin, you can in...
Near line 463: When ‘distro-agnostic’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...tall scipy --user ## Spack Spack is a distro agnostic package manager for Linux, which is dev...
Near line 475: In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects.
Context: ... and all dependencies from scratch. Afterwards, QGIS can be used via: ``` spack load ...
Near line 502: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... release version (portqgis3) and the long term version (portqgis3-ltr). This will i...
Near line 504: Unpaired symbol: ‘[’ seems to be missing
Context: ...able. Installing MacPorts and updating it and the ...
Near line 504: Consider adding two commas here.
Context: ...s_ are made with the Terminal. QGIS is however installed as an app bundle at `/Applica...
Near line 512: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...sudo port info qgis3Install port, e.g with GRASS GIS:sudo port install ...
Near line 529: Consider using “incompatible” to avoid wordiness.
Context: ...nstallation of Homebrew and MacPorts is not compatible and will almost certainly lead to confl...
Near line 529: Possible missing comma found.
Context: ...ou choose to install one of the package systems you need to uninstall the other. {{< ri...
Near line 585: Did you mean “Google Play Store”?
Context: ...of QGIS for Android can be found on the google play store. https://play.google.com/store/apps/de...
Near line 593: Do not mix variants of the same word (‘optimize’ and ‘optimise’) within a single text.
Context: ...esktop application. It is only slightly optimized for touch devices and therefore needs t...
Near line 593: Do not mix variants of the same word (‘optimize’ and ‘optimise’) within a single text.
Context: ...r apps available which are designed and optimized specifically for touch devices. {{< ric...
|
Can you lower case the The? The good to merge thanks. |
There was a problem hiding this comment.
Actionable comments posted: 1
Out of diff range and nitpick comments (5)
content/resources/installation-guide/index.md (5)
Line range hint
45-45: Simplify the expression for clarity.- The installer is able to install from internet or just download all needed packages beforehand. + The installer can install from the internet or download all needed packages beforehand.Using "can" instead of "is able to" makes the sentence more concise and easier to understand.
Line range hint
70-70: Add a comma after 'builds' for better readability.- Before installing any of the nightly builds note the [warning](#warning). + Before installing any of the nightly builds, note the [warning](#warning).This comma helps to separate the introductory phrase from the main clause, improving the flow of the sentence.
Line range hint
98-98: Correct the grammatical number agreement.- First install some tools you will need for this instructions: + First install some tools you will need for these instructions:Changing "this" to "these" corrects the grammatical number to match "instructions," which is plural.
Line range hint
165-165: Add commas to separate clauses for clarity.- As unstable, not yet released debian versions (testing) and ubuntugis-unstable can have library changes the packages might sooner or later be broken for these targets, when the development in debian, ubuntu or ubuntugis-unstable moves on and their packages used as dependencies in qgis change. + As unstable, not yet released debian versions (testing) and ubuntugis-unstable can have library changes, the packages might sooner or later be broken for these targets, when the development in debian, ubuntu, or ubuntugis-unstable moves on and their packages used as dependencies in qgis change.Adding commas helps to separate the clauses and makes the sentence easier to read and understand.
Line range hint
171-171: Correct verb form and spelling.- whose packages are rebuild on regular basis and will also pickup the updated dependencies automatically + whose packages are rebuilt on a regular basis and will also pick up the updated dependencies automaticallyChanging "rebuild" to "rebuilt" corrects the verb form, and separating "pickup" into "pick up" corrects the spelling for the verb usage.
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- content/resources/installation-guide/index.md (2 hunks)
- playwright/ci-test/tests/fixtures/installation-guide-page.ts (1 hunks)
Files skipped from review due to trivial changes (1)
- playwright/ci-test/tests/fixtures/installation-guide-page.ts
Additional Context Used
LanguageTool (40)
content/resources/installation-guide/index.md (40)
Near line 36: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...}) [Checksum]({{< param "lr_sha" >}})| |Long Term Release|{{< param "ltrrelease" >}} {{< ...
Near line 39: Possible missing comma found.
Context: ...alone installers. In the feature freeze phase that also acts as release candidate...
Near line 45: As a shorter alternative for ‘able to’, consider using “can”.
Context: ...Python, GRASS, GDAL, etc. The installer is able to install from internet or just download ...
Near line 51: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ease_ and/or QGIS LTR to install the long term release. Alternatively to _Expre...
Near line 60: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...y build of the upcoming point release| |Long Term Release|{{< param "ltrrelease" >}} {{< ...
Near line 61: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...1]](#id1)|Nightly build of the upcoming long term point release| |Development|{{< param "...
Near line 70: Possible missing comma found.
Context: .... Before installing any of the nightly builds note the warning. # Linux ...
Near line 98: The singular determiner ‘this’ may not agree with the plural noun ‘instructions’. Did you mean “these”?
Context: ...st install some tools you will need for this instructions: ``` sudo apt install gnu...
Near line 160: It is considered good style to insert a comma after introductory phrases with dates or proper nouns.
Context: ... individual distributions provide. For Ubuntu we also used to have extra packages in ...
Near line 160: Possible missing comma found.
Context: ...tu itself for LTS versions. If you want those you also need to include ubuntugis-unst...
Near line 165: Consider adding two commas here.
Context: ... have library changes the packages might sooner or later be broken for these targets, when the d...
Near line 165: It appears that a comma is missing.
Context: ...as dependencies in qgis change. In that event you can either - move to a stable debi...
Near line 171: Consider using either the past participle “rebuilt” or the present participle “rebuilding” here.
Context: ...branches and master) whose packages are rebuild on regular basis and will also pickup t...
Near line 171: The word “pickup” is a noun. The verb is spelled with a space.
Context: ... rebuild on regular basis and will also pickup the updated dependencies automatically ...
Near line 186: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...org/ubuntugis-nightly-release | | | | Long Term Release Repository | {{< param "ltrvers...
Near line 217: Possible missing comma found.
Context: ...planned for 2024-04-25 To use the qgis archive you have to first add the archive’s rep...
Near line 234: Consider inserting a comma for improved readability.
Context: ...After you have verified the output you can install the key with:sudo mkd...
Near line 240: Consider adding a comma after ‘Alternatively’ for more clarity.
Context: .../keyrings/qgis-archive-keyring.gpg ``` Alternatively you can download the key directly witho...
Near line 259: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...keyring.gpgExample for the latest long term release for Ubuntu 22.04 Jammy:Ty...
Near line 270: Possible missing comma found.
Context: ...ngs/qgis-archive-keyring.gpg ``` After that type the commands below to install QGIS...
Near line 270: It appears that a comma is missing.
Context: ...gis-archive-keyring.gpg ``` After that type the commands below to install QGIS: ``...
Near line 288: Consider adding a comma here.
Context: ...t themeClass="coloring-1" >}} ##### Note Please remove all the QGIS and GRASS packages ...
Near line 313: Possible missing comma found.
Context: ...do dnf copr enable dani/qgis ``` After that type the commands below to install QGIS...
Near line 313: It appears that a comma is missing.
Context: ...f copr enable dani/qgis ``` After that type the commands below to install QGIS: ``...
Near line 332: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...oud.org/coprs/dani/qgis/ ### QGIS LTR (Long Term Release) Enable the repository: ``` s...
Near line 340: Possible missing comma found.
Context: ...nf copr enable dani/qgis-ltr ``` After that type the commands below to install QGIS...
Near line 340: It appears that a comma is missing.
Context: ...pr enable dani/qgis-ltr ``` After that type the commands below to install QGIS: ``...
Near line 407: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... pacman -S qgis ``` ### QGIS LTR QGIS Long Term Release is available in AUR (Arch User ...
Near line 457: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...eed to install additional Python modules, because they are needed by a plugin, you can in...
Near line 463: When ‘distro-agnostic’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...tall scipy --user ## Spack Spack is a distro agnostic package manager for Linux, which is dev...
Near line 475: In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects.
Context: ... and all dependencies from scratch. Afterwards, QGIS can be used via: ``` spack load ...
Near line 502: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... release version (portqgis3) and the long term version (portqgis3-ltr). This will i...
Near line 504: Consider adding two commas here.
Context: ...s_ are made with the Terminal. QGIS is however installed as an app bundle at `/Applica...
Near line 512: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...sudo port info qgis3Install port, e.g with GRASS GIS:sudo port install ...
Near line 529: Consider using “incompatible” to avoid wordiness.
Context: ...nstallation of Homebrew and MacPorts is not compatible and will almost certainly lead to confl...
Near line 529: Possible missing comma found.
Context: ...ou choose to install one of the package systems you need to uninstall the other. {{< ri...
Near line 585: Possible missing comma found.
Context: ...-current OpenBSD # Android An old and deprecated not touch optimised release of QGIS for...
Near line 585: Did you mean “Google Play Store”?
Context: ...of QGIS for Android can be found on the google play store. https://play.google.com/store/apps/de...
Near line 593: Do not mix variants of the same word (‘optimize’ and ‘optimise’) within a single text.
Context: ...esktop application. It is only slightly optimized for touch devices and therefore needs t...
Near line 593: Do not mix variants of the same word (‘optimize’ and ‘optimise’) within a single text.
Context: ...r apps available which are designed and optimized specifically for touch devices. {{< ric...
Additional comments not posted (1)
content/resources/installation-guide/index.md (1)
19-19: Move the download link to a more prominent position at the top of the guide.This change aligns with the PR's objective to enhance visibility and accessibility of the download link, making it easier for users to find the installation resources.
| @@ -34,8 +36,6 @@ For beginners the easiest way is using the standalone installers: | |||
| |Long Term Release|{{< param "ltrrelease" >}} {{< param "ltrcodename" >}} {{< param "ltrnote" >}}|[Installer]({{< param "ltr_msi">}}) [Checksum]({{< param "ltr_sha">}})| | |||
| |Development|{{< param "devversion" >}} master|[Weekly snapshots]({{< param "weekly_msi">}})| | |||
|
|
|||
| See also [The main installers page]({{< ref "download" >}}). | |||
|
|
|||
| The weekly snapshots of the nightly qgis-dev package of OSGeo4W are for users that cannot use OSGeo4W (see below) for some reason or just prefer standalone installers. In the feature freeze phase that also acts as **release candidate**. | |||
There was a problem hiding this comment.
Consider adding a comma for clarity.
- In the feature freeze phase that also acts as **release candidate**.
+ In the feature freeze phase, that also acts as **release candidate**.This change improves readability and clarifies that the feature freeze phase is acting as the release candidate.
Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| The weekly snapshots of the nightly qgis-dev package of OSGeo4W are for users that cannot use OSGeo4W (see below) for some reason or just prefer standalone installers. In the feature freeze phase that also acts as **release candidate**. | |
| The weekly snapshots of the nightly qgis-dev package of OSGeo4W are for users that cannot use OSGeo4W (see below) for some reason or just prefer standalone installers. In the feature freeze phase, that also acts as **release candidate**. |
Please find below a screenshot of the change:
Summary by CodeRabbit
InstallationGuidePageclass.