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

Minor improvements #373

Merged
merged 8 commits into from
Sep 6, 2024
Merged

Minor improvements #373

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
53e2838
chore: ignore .hugo_build.lock file and do not sync the hugo executab…
dsferruzza Sep 5, 2024
e01854e
style: remove useless spaces
dsferruzza Sep 5, 2024
994fc6d
feat: improve README
dsferruzza Sep 5, 2024
c2804cc
fix: typos
dsferruzza Sep 5, 2024
f30bdc0
fix: typo
dsferruzza Sep 5, 2024
86edcb7
refactor: accept suggestion
dsferruzza Sep 5, 2024
a98c5f8
fix: script name & typo
dsferruzza Sep 5, 2024
58bda82
Merge branch 'main' into minor-improvements
juliamrch Sep 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,5 @@
.clever.json
.vale.ini
/styles
/.hugo_build.lock
/hugo
Empty file removed .hugo_build.lock
View file
Open in desktop
Empty file.
25 changes: 13 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

# Clever Cloud Documentation

This is a Hugo project with a theme called "Hextra" added a module..</p>
This is a [Hugo](https://gohugo.io) project with a theme called [Hextra](https://github.com/imfing/hextra) added as a module.</p>

## See deployed Documentation

Expand All @@ -27,11 +27,14 @@

Check your Go version, it need to be above go `1.21.1`.

### Install Hugo

Either [install Hugo](https://gohugo.io/installation/) globally in your system or put its [executable](https://github.com/gohugoio/hugo/releases) in the projet's root.

Check failure on line 32 in README.md

View workflow job for this annotation

GitHub Actions / Run Vale Linter 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'projet's'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'projet's'?", "location": {"path": "README.md", "range": {"start": {"line": 32, "column": 154}}}, "severity": "ERROR"}

### Start locally

To run the site in your browser, there is a server built in Hugo you can summon with:
`hugo server`
A bunch of option a available:
To run the site locally, there is a server built in Hugo you can summon with: `hugo server`.
A bunch of options are available:

```bash
-b, --baseURL string hostname and path to the root
Expand All @@ -48,9 +51,9 @@

## Project basic configuration and architecture

The theme used here is called [Hexa](https://imfing.github.io/hextra/).
The theme used here is called [Hextra](https://imfing.github.io/hextra/).

Check warning on line 54 in README.md

View workflow job for this annotation

GitHub Actions / Run Vale Linter 

[vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('is called').

Raw Output:
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('is called').", "location": {"path": "README.md", "range": {"start": {"line": 54, "column": 21}}}, "severity": "INFO"}

The `clevercloud-deploy-script.sh` script runs the compilation with the right options and server the content of the public folder.
The `clevercloud-deploy-script.sh` script runs the compilation with the right options and serves the content of the public folder.

This is why the Clever Cloud application running this app needs to have a webroot serving `/public/`.

Expand All @@ -61,8 +64,8 @@
### Run locally

1. Clone this repo: `git clone git@github.com:CleverCloud/documentation.git`
2. Go to the repo root `cd documentation`
3. Start the theme module: `hugo mod get github.com/imfing/hextra` (optional, but do it if you encounter an error on step 4,to update the theme)
2. Go to the repo root: `cd documentation`

Check failure on line 67 in README.md

View workflow job for this annotation

GitHub Actions / Run Vale Linter 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'repo'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'repo'?", "location": {"path": "README.md", "range": {"start": {"line": 67, "column": 14}}}, "severity": "ERROR"}
3. Start the theme module: `hugo mod get github.com/imfing/hextra` (optional, but do it if you encounter an error on step 4, to update the theme)
4. Run `hugo server`

Local site is displayed on <http://localhost:1313>
Expand All @@ -71,7 +74,7 @@

Hugo uses [Goldmak](https://github.com/yuin/goldmark), a Markdown parser written in Go, compliant with CommonMark 0.30(see [the specification here](https://spec.commonmark.org/)).

Therefore, for better readability and maintaining, all markdown files for this project are linted with <https://github.com/DavidAnson/markdownlint-cli2>.
Therefore, for better readability and maintaining, all markdown files for this project are linted with <https://github.com/DavidAnson/markdownlint-cli2>.

Check warning on line 77 in README.md

View workflow job for this annotation

GitHub Actions / Run Vale Linter 

[vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('are linted').

Raw Output:
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('are linted').", "location": {"path": "README.md", "range": {"start": {"line": 77, "column": 88}}}, "severity": "INFO"}
We strongly recommend that you follow the validation rules described here: <https://github.com/DavidAnson/markdownlint#rules--aliases>.

This linter can be downloaded and run locally, or used via VSCode:
Expand All @@ -81,7 +84,7 @@

#### Linting configuration

**Ignored markdown files** are listed in the `.markdownlintignore`.
**Ignored markdown files** are listed in the `.markdownlintignore`.

Check warning on line 87 in README.md

View workflow job for this annotation

GitHub Actions / Run Vale Linter 

[vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('are listed').

Raw Output:
{"message": "[Google.Passive] In general, use active voice instead of passive voice ('are listed').", "location": {"path": "README.md", "range": {"start": {"line": 87, "column": 28}}}, "severity": "INFO"}
**Ignored specifications**, such as some HTML tag of Web Components, are configured in the `.markdownlint.jsonc`
**Editorial checks** with [Vale.sh](https://vale.sh). Install Vale on your machine or as a VSCode extension if you want to run checks before submitting your PR. This project is already configured to use it.

Expand Down Expand Up @@ -171,5 +174,3 @@

1. Create a new partial in `/layouts/shortcodes/content`
2. Add it to the relevant pages like this: `{{% content/your-partial %}}`


3 changes: 1 addition & 2 deletions data/icons.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ haskell: <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox=
java: <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path fill="currentColor" d="M9.37 17.51c-3.09.86 1.87 2.64 5.8 1a7.18 7.18 0 0 1-1.1-.54a11.59 11.59 0 0 1-4.16.18c-1.31-.15-.54-.64-.54-.64zm5.33-1.68a16.27 16.27 0 0 1-5.36.26c-1.31-.14-.45-.77-.45-.77c-3.4 1.12 1.89 2.4 6.64 1a2.25 2.25 0 0 1-.83-.49zm1.82-9.73s-6.87 1.71-3.59 5.49a1.47 1.47 0 0 1-.25 2.12s2.46-1.27 1.33-2.86s-1.86-2.22 2.51-4.75z"/><path fill="currentColor" d="M18.13 19.14s.56.46-.63.82c-2.27.69-9.43.9-11.42 0c-.72-.31.62-.74 1-.83a2.54 2.54 0 0 1 .69-.08c-.8-.56-5.15 1.1-2.21 1.58c8.05 1.37 14.64-.56 12.57-1.49zm-2.76-4.88a7 7 0 0 1 .92-.49s-1.51.27-3 .4a28.11 28.11 0 0 1-4.82.05C6.09 13.91 9.74 13 9.74 13a6.81 6.81 0 0 0-3.16.75c-2.06 1.03 5.09 1.48 8.79.51zm.91 2.44a.39.39 0 0 1-.08.09c5-1.32 3.18-4.65.78-3.81a.71.71 0 0 0-.33.25s.14-.05.43-.12c1.22-.25 2.92 1.63-.8 3.59zM12 13c-.74-1.67-3.26-3.14 0-5.71C16.09 4.08 14 2 14 2c.84 3.31-3 4.31-4.34 6.37c-.93 1.41.47 2.92 2.34 4.63z"/><path fill="currentColor" d="M16.41 21.32a29.75 29.75 0 0 1-9.14.14s.46.38 2.84.53c3.61.23 9.15-.12 9.29-1.83c0 0-.26.64-2.99 1.16z"/></svg>
node: <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 32 32"><path fill="currentColor" d="M15.994 3c-.365 0-.73.09-1.045.27L5.04 8.99C4.4 9.36 4 10.06 4 10.8v10.38c0 .75.4 1.44 1.04 1.81l2.6 1.5c1.26.62 1.71.62 2.28.62c1.87 0 2.94-1.13 2.94-3.09V11.31a.29.29 0 0 0-.29-.29h-1.25a.286.286 0 0 0-.29.29v10.7c0 .88-.91 1.74-2.38 1.01l-2.72-1.57a.303.303 0 0 1-.16-.27V10.81c0-.12.06-.22.16-.28l9.91-5.72a.29.29 0 0 1 .31 0l9.91 5.72c.1.06.16.16.16.27v10.38c0 .11-.06.22-.15.27l-9.92 5.73a.34.34 0 0 1-.31 0l-2.55-1.51a.23.23 0 0 0-.24-.02c-.71.4-.84.45-1.5.68c-.16.05-.41.15.09.43l3.31 1.96c.32.18.68.28 1.04.28c.37 0 .73-.1 1.05-.28l9.92-5.73c.64-.37 1.04-1.06 1.04-1.81V10.81c0-.75-.4-1.44-1.04-1.81l-9.92-5.73c-.316-.18-.68-.27-1.046-.27zm2.666 8.006c-2.83 0-4.52 1.2-4.52 3.2c0 2.17 1.68 2.768 4.4 3.038c3.25.32 3.5.802 3.5 1.442c0 1.1-.89 1.57-2.98 1.57c-2.63 0-3.21-.661-3.4-1.961a.28.28 0 0 0-.28-.24h-1.29a.28.28 0 0 0-.28.28c0 1.67.91 3.66 5.25 3.66c3.14 0 4.94-1.24 4.94-3.4c0-2.14-1.45-2.71-4.49-3.12c-3.09-.4-3.4-.61-3.4-1.33c0-.6.27-1.39 2.55-1.39c2.03 0 2.79.44 3.1 1.81c.03.13.14.23.28.23h1.29c.08 0 .15-.04.21-.1a.27.27 0 0 0 .07-.22c-.2-2.36-1.77-3.47-4.95-3.47z"/></svg>
ruby: <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 15 15"><path fill="currentColor" d="M4.293 4L8.058.236L9.73 4H4.293Zm10-4l-3.632 3.632L9.047 0h5.246ZM.236 8.058L4 9.73V4.293L.236 8.058Zm3.396 2.603L0 9.047v5.246l3.632-3.632ZM5 9.293L9.293 5H5v4.293Zm10 4.438l-3.907-9.117L15 .707v13.024Zm-.952.317l-3.717-8.672l-4.955 4.955l8.672 3.717Zm-9.434-2.955L13.731 15H.707l3.907-3.907Z"/></svg>
php: <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16"><path fill="currentColor" d="M7.198 3.06a2.883 2.883 0 0 0-2.886 2.88v6.407A2.155 2.155 0 0 1 2.156 14.5A2.155 2.155 0 0 1 0 12.347a.78.78 0 0 1 1.563 0a.593.593 0 0 0 1.187 0V5.941A4.444 4.444 0 0 1 7.198 1.5a4.449 4.449 0 0 1 4.274 3.206A4.673 4.673 0 0 1 16 9.373a.785.785 0 0 1-.008.114a.784.784 0 0 1 .008.115v4.118c0 .43-.35.78-.781.78H7.198a.78.78 0 0 1-.781-.78V9.602c0-.431.35-.78.78-.78a2.883 2.883 0 0 0 2.886-2.881A2.883 2.883 0 0 0 7.198 3.06Zm7.248 6.427a.784.784 0 0 1-.008-.114a3.112 3.112 0 0 0-2.805-3.095a4.446 4.446 0 0 1-3.654 4.035v2.627h2.448v-1.737a.78.78 0 0 1 1.563 0v1.737h2.447V9.602c0-.04.003-.077.009-.115Z"/></svg>
php: <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16"><path fill="currentColor" d="M7.198 3.06a2.883 2.883 0 0 0-2.886 2.88v6.407A2.155 2.155 0 0 1 2.156 14.5A2.155 2.155 0 0 1 0 12.347a.78.78 0 0 1 1.563 0a.593.593 0 0 0 1.187 0V5.941A4.444 4.444 0 0 1 7.198 1.5a4.449 4.449 0 0 1 4.274 3.206A4.673 4.673 0 0 1 16 9.373a.785.785 0 0 1-.008.114a.784.784 0 0 1 .008.115v4.118c0 .43-.35.78-.781.78H7.198a.78.78 0 0 1-.781-.78V9.602c0-.431.35-.78.78-.78a2.883 2.883 0 0 0 2.886-2.881A2.883 2.883 0 0 0 7.198 3.06Zm7.248 6.427a.784.784 0 0 1-.008-.114a3.112 3.112 0 0 0-2.805-3.095a4.446 4.446 0 0 1-3.654 4.035v2.627h2.448v-1.737a.78.78 0 0 1 1.563 0v1.737h2.447V9.602c0-.04.003-.077.009-.115Z"/></svg>
# alternative logo
#php: <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path fill="currentColor" d="M2.15 16.78h1.57a.14.14 0 0 0 .14-.12l.35-1.82h1.22a4.88 4.88 0 0 0 1.51-.2A2.79 2.79 0 0 0 8 14a3.18 3.18 0 0 0 .67-.85a3.43 3.43 0 0 0 .36-1a2.43 2.43 0 0 0-.41-2.16a2.64 2.64 0 0 0-2.09-.78h-3a.16.16 0 0 0-.15.13L2 16.6a.19.19 0 0 0 0 .13a.17.17 0 0 0 .15.05zM5 10.62h1a1.45 1.45 0 0 1 1.08.29c.17.18.2.52.11 1a1.81 1.81 0 0 1-.57 1.12a2.17 2.17 0 0 1-1.33.33h-.8zm9.8-.95a2.7 2.7 0 0 0-1.88-.51h-1.19l.33-1.76a.15.15 0 0 0 0-.13a.16.16 0 0 0-.11 0h-1.57a.14.14 0 0 0-.14.12l-1.38 7.27a.13.13 0 0 0 0 .12a.13.13 0 0 0 .11.06h1.54a.14.14 0 0 0 .14-.13l.77-4.07h1.11c.45 0 .61.1.66.16a.81.81 0 0 1 0 .62l-.61 3.24a.13.13 0 0 0 0 .12a.14.14 0 0 0 .11.06h1.56a.16.16 0 0 0 .15-.13l.64-3.4a1.7 1.7 0 0 0-.24-1.64zm4.52-.51h-3.13a.14.14 0 0 0-.15.13l-1.46 7.31a.16.16 0 0 0 0 .13a.14.14 0 0 0 .11.05h1.63a.14.14 0 0 0 .15-.12l.37-1.82h1.27a5.28 5.28 0 0 0 1.56-.2a3 3 0 0 0 1.18-.64a3.31 3.31 0 0 0 .7-.85a3.45 3.45 0 0 0 .37-1a2.38 2.38 0 0 0-.42-2.16a2.81 2.81 0 0 0-2.18-.83zm.62 2.77a1.83 1.83 0 0 1-.6 1.12a2.28 2.28 0 0 1-1.37.33h-.8l.54-2.76h1a1.6 1.6 0 0 1 1.13.29c.16.18.16.52.1 1.02z"/></svg>
python: <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path fill="currentColor" d="M9.585 11.692h4.328s2.432.039 2.432-2.35V5.391S16.714 3 11.936 3C7.362 3 7.647 4.983 7.647 4.983l.006 2.055h4.363v.617H5.92s-2.927-.332-2.927 4.282s2.555 4.45 2.555 4.45h1.524v-2.141s-.083-2.554 2.513-2.554zm-.056-5.74a.784.784 0 1 1 0-1.57a.784.784 0 1 1 0 1.57z"/><path fill="currentColor" d="M18.452 7.532h-1.524v2.141s.083 2.554-2.513 2.554h-4.328s-2.432-.04-2.432 2.35v3.951s-.369 2.391 4.409 2.391c4.573 0 4.288-1.983 4.288-1.983l-.006-2.054h-4.363v-.617h6.097s2.927.332 2.927-4.282s-2.555-4.451-2.555-4.451zm-3.981 10.436a.784.784 0 1 1 0 1.57a.784.784 0 1 1 0-1.57z"/></svg>
Expand Down Expand Up @@ -116,4 +116,3 @@ hugo: <svg viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path fill="cu
html: <svg viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path fill="currentColor" d="M1.5 0h21l-1.91 21.563L11.977 24l-8.564-2.438L1.5 0zm7.031 9.75l-.232-2.718 10.059.003.23-2.622L5.412 4.41l.698 8.01h9.126l-.326 3.426-2.91.804-2.955-.81-.188-2.11H6.248l.33 4.171L12 19.351l5.379-1.443.744-8.157H8.531z"/></svg>
mdbook: <svg viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path fill="currentColor" d="M22.77 5.343c.023.337 0 .613-.073.817l-4.314 14.227c-.072.252-.24.445-.504.6a1.67 1.67 0 0 1-.805.23H3.772c-1.154 0-1.839-.337-2.079-1.01-.096-.264-.096-.469.012-.625.108-.144.288-.216.553-.216h12.52c.89 0 1.514-.168 1.85-.493.337-.324.686-1.07 1.034-2.21l3.954-13.05c.216-.71.12-1.334-.265-1.875-.384-.54-.937-.817-1.646-.817H8.735c-.12 0-.373.048-.734.132l.012-.048A2.458 2.458 0 0 0 7.33.933a.979.979 0 0 0-.517.168 1.794 1.794 0 0 0-.385.337c-.096.12-.18.264-.276.456a5.76 5.76 0 0 0-.228.517 7.95 7.95 0 0 1-.217.505c-.084.18-.156.324-.24.444-.06.073-.144.18-.24.3-.096.121-.193.241-.265.337a.776.776 0 0 0-.132.265c-.024.084-.012.216.024.384.036.168.048.289.048.373-.036.36-.168.829-.396 1.394-.229.564-.433.973-.613 1.213a5.201 5.201 0 0 1-.312.325c-.169.168-.277.312-.313.444-.036.048-.036.18-.012.409.036.216.048.372.036.456-.036.325-.156.757-.36 1.298a9.47 9.47 0 0 1-.601 1.322c-.024.06-.108.168-.24.336-.133.168-.217.3-.24.409-.025.072-.013.216.011.408.024.193.024.337-.012.433-.072.36-.216.805-.432 1.322-.217.516-.433.949-.65 1.321-.06.097-.131.205-.24.337-.096.132-.18.24-.24.336a.927.927 0 0 0-.12.3.53.53 0 0 0 .048.277c.036.132.048.228.048.313-.012.132-.024.312-.06.528-.024.216-.048.349-.048.385-.216.576-.204 1.19.024 1.826.264.745.745 1.382 1.43 1.899.685.516 1.406.769 2.139.769H17.05c.625 0 1.214-.205 1.767-.625.553-.42.925-.937 1.105-1.55l3.966-13.05c.216-.696.12-1.31-.265-1.862-.204-.3-.48-.505-.853-.649ZM7.16 15.677l1.707-5.143h1.297c.457 0 3.46-.204 3.052 2.103-.408 2.307-2.259 3.028-4.422 3.052-2.162.024-1.634-.012-1.634-.012zm2.283-.721c.565-.012 2.271-.349 2.656-2.055.384-1.706-1.382-1.61-1.382-1.61h-1.07l-1.225 3.665c.012.012.469.012 1.021 0zm-.396-5.78 1.646-5.107h1.178l.096 4.086 2.835-4.086h1.19l-1.634 5.107h-.853l1.502-4.253-2.944 4.253h-.817l-.096-4.205-1.298 4.205z"/></svg>
nuxt: <svg viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path fill="currentColor" d="M13.4642 19.8295h8.9218c.2834 0 .5618-.0723.8072-.2098a1.5899 1.5899 0 0 0 .5908-.5732 1.5293 1.5293 0 0 0 .216-.783 1.529 1.529 0 0 0-.2167-.7828L17.7916 7.4142a1.5904 1.5904 0 0 0-.5907-.573 1.6524 1.6524 0 0 0-.807-.2099c-.2833 0-.5616.0724-.807.2098a1.5904 1.5904 0 0 0-.5907.5731L13.4642 9.99l-2.9954-5.0366a1.5913 1.5913 0 0 0-.591-.573 1.6533 1.6533 0 0 0-.8071-.2098c-.2834 0-.5617.0723-.8072.2097a1.5913 1.5913 0 0 0-.591.573L.2168 17.4808A1.5292 1.5292 0 0 0 0 18.2635c-.0001.2749.0744.545.216.783a1.59 1.59 0 0 0 .5908.5732c.2454.1375.5238.2098.8072.2098h5.6003c2.219 0 3.8554-.9454 4.9813-2.7899l2.7337-4.5922L16.3935 9.99l4.3944 7.382h-5.8586ZM7.123 17.3694l-3.9083-.0009 5.8586-9.8421 2.9232 4.921-1.9572 3.2892c-.7478 1.1967-1.5972 1.6328-2.9163 1.6328z"/></svg>

Loading