-
Notifications
You must be signed in to change notification settings - Fork 14
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
Publish docs on readthedocs #1254
Merged
Merged
Changes from 55 commits
Commits
Show all changes
61 commits
Select commit
Hold shift + click to select a range
785c423
Create mkdocs.yml
camillemonchicourt 6e3b89e
Create .readthedocs.yaml
camillemonchicourt b7dec2d
Move mkdocs.yml to docs/mkdocs.yml
camillemonchicourt 06b2d09
Update .readthedocs.yaml
camillemonchicourt 672a040
Update mkdocs.yml
camillemonchicourt 971f7db
Move docs/mkdocs.yml to mkdocs.yml
camillemonchicourt 717763f
Move docs/.readthedocs.yaml to .readthedocs.yaml
camillemonchicourt 1ecb3da
Update mkdocs.yml
camillemonchicourt 690f604
Create index.md
camillemonchicourt 94309e0
Update mkdocs.yml
camillemonchicourt 63f5fe9
Move to readthedocs theme
camillemonchicourt 235b801
Update mkdocs.yml
camillemonchicourt cdbbeb8
Update .readthedocs.yaml
camillemonchicourt 14fdc5c
Move mkdocs.yml to docs/mkdocs.yml
camillemonchicourt 136adb0
Update mkdocs.yml
camillemonchicourt 574b2c4
Update .readthedocs.yaml
camillemonchicourt a11b96b
Rename docs/mkdocs.yml to mkdocs.yml
camillemonchicourt ab82971
Update installation.md header sizes
camillemonchicourt d536efc
Update customization.md
camillemonchicourt 75a434a
Update customization-scripts-GDPR.md
camillemonchicourt faf661a
Update customization.md
camillemonchicourt a94a428
Update customization.md
camillemonchicourt 23d4808
Update server-side-rendering.md
camillemonchicourt 7ca19af
Update mkdocs.yml
camillemonchicourt 4879ccd
Update mkdocs.yml
camillemonchicourt a39b47f
Update mkdocs.yml
camillemonchicourt 75941c9
Update index.md
camillemonchicourt 82e218e
Update mkdocs.yml
camillemonchicourt d93f174
Update development.md
camillemonchicourt 6c022a5
Update development.md
camillemonchicourt 5ad1957
Update mkdocs.yml
camillemonchicourt 6bce5d5
Add logo, favicon and homepage in doc
bruhnild 0ef671f
Update index homepage and summary navbar
bruhnild 23a8ae3
Add infos about contributing doc
bruhnild c0efd87
Fix indent and links
bruhnild 84baa62
Review development.md
camillemonchicourt 526fb6c
Remove logos from index.md
camillemonchicourt e4a0244
Add material for mkdocs
bruhnild 25e92fb
fix ci error remove emoji extension
bruhnild 0c60c71
Add requirements
bruhnild 0a35823
Improve toc and knowledge and architecture section
bruhnild 351d286
reindent code blocs
bruhnild 35a7e68
Add context to deployment_solution.md and main_framework.md
bruhnild 2009eeb
Fix titles
bruhnild 8a7a207
Include issue's comments in doc for custo and add a contributing section
bruhnild d4e2711
Add contributing doc
bruhnild 264d523
Split customization doc
bruhnild b841c0a
Remove rando v3 mention
dtrucs 9094631
Update README
bruhnild 5181b8d
Improve contributing page
bruhnild 014d4b3
Improve documentation and dev setup pages
bruhnild 2559b96
Add extension to manage issues links in changelog
bruhnild 44f2431
Improve contributing documentation
dtrucs 5fbf0b7
Update contributing issue report
dtrucs 74b24d0
Update readme.md and contributing.md
bruhnild 11d628e
Add suggestion for improving contributing.md
bruhnild 38b9ffe
Update index.md, readme.md and fix gdpr title page
bruhnild 2e718a2
Fix links in readme.md
bruhnild ad5d80e
Add portals examples in readme and fix titles in doc
bruhnild 38e2c6c
Fix demo link
bruhnild 32e919b
Update shields in readme
bruhnild File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
# Read the Docs configuration file for MkDocs projects | ||
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details | ||
|
||
# Required | ||
version: 2 | ||
|
||
# Set the version of Python and other tools you might need | ||
build: | ||
os: ubuntu-22.04 | ||
tools: | ||
python: "3.12" | ||
|
||
python: | ||
install: | ||
- requirements: ./mkdocs/requirements.txt | ||
|
||
mkdocs: | ||
configuration: ./mkdocs/mkdocs.yml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,35 +1,53 @@ | ||
# Geotrek-rando V3 | ||
# Geotrek-rando | ||
|
||
![Search](https://geotrek.ecrins-parcnational.fr/images/gtr3-04-search.jpg) | ||
![Search](img/home_ecrins.png) | ||
|
||
Geotrek-rando is the public web application displaying the interface you can use to value your territory treks and tourism products! | ||
Demo available at https://gtr3demo.ecrins-parcnational.fr. | ||
Demo available at [https://gtr3demo.ecrins-parcnational.fr](https://gtr3demo.ecrins-parcnational.fr). | ||
|
||
The third version is a full redesign and rewriting of Geotrek-rando with React, and NextJS for Server side rendering (SSR) and SEO. | ||
|
||
Geotrek-rando v3 is directly connected to Geotrek-admin v2 API. | ||
Geotrek-rando is directly connected to Geotrek-admin v2 API. | ||
|
||
Read more in the [general presentation](./docs/presentation-fr.md). | ||
## 💡 Présentation (french) | ||
|
||
## Documentation for administrators | ||
Read more in the [general presentation](./presentation-fr.md). | ||
|
||
- [Installation for production](./docs/installation.md) | ||
- [Customization](./docs/customization.md) | ||
## 🚀 Installation | ||
|
||
## Documentation for developers | ||
- [Production setup](./installation.md) | ||
|
||
- [Installation on a dev machine](./docs/development.md) | ||
- [Deployment](./docs/deployment.md) | ||
## 🎨 Customization | ||
|
||
## Getting started | ||
- [Introduction](customization/customization-introduction.md) | ||
- [Settings](customization/customization-settings.md) | ||
- [Theme and style](customization/customization-themestyles.md) | ||
- [Icons](customization/customization-icons.md) | ||
- [Translation](customization/customization-translation.md) | ||
- [HTML and scripts](customization/customization-htmlscripts.md) | ||
- [GDPR](customization/customization-gdpr.md) | ||
- [Media management](customization/customization-mediamanagement.md) | ||
|
||
- Follow the [development](./docs/development.md) docs | ||
- Head to [localhost:3000](http://localhost:3000) | ||
## 🔧 Development | ||
|
||
- [Installation](./development/installation.md) | ||
- [Deployment](./development/deployment.md) | ||
- [Contributing](./development/contributing.md) | ||
|
||
## ✨ Knowledge | ||
|
||
- [Caching strategies](./knowledge/caching.md) | ||
- [Debug mode](./knowledge/debug.md) | ||
- [Pages and navigation](./knowledge/pages-and-navigation.md) | ||
- [Server side rendering](./knowledge/server-side-rendering.md) | ||
|
||
## Architecture decision records | ||
## 🧱 Architecture decision record | ||
|
||
- [Main framework](./docs/adrs/main_framework.md) | ||
- [Deployment solution](./docs/adrs/deployment_solution.md) | ||
- [Main framework](./adrs/main_framework.md) | ||
- [Deployment solution](./adrs/deployment_solution.md) | ||
|
||
## 🪄 Getting started | ||
|
||
- Follow the [development](./development/installation.md) docs | ||
- Head to [localhost:3000](http://localhost:3000) | ||
|
||
<a href="https://territoires.makina-corpus.com/"><img src="https://geotrek.fr/assets/img/logo_makina.svg" alt="Logo MCT" width="115"></a> | ||
[![](https://geotrek.fr/assets/img/logo_autonomens-h120m.png)](https://datatheca.com/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Je me dis que pour les deux instances de démo ça serait chouette aussi de mettre un lien vers l'admin (+ identifiants) pour quel les curieu·x·ses puissent aller tester des modifications ? Mais est-ce l'endroit pour mettre des liens vers l'admin ? Est-ce qu'il ne faudrait pas plutôt mettre un lien vers une section "Démo" équivalente sur le répo de Geotrek-Admin (à créer) ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
On pourrait aussi mettre directement 2 ou 3 exemples de vrais portails pour montrer des vrais usages, moins basiques, non ?
Mettre les liens des admins, etc... pourquoi pas, mais faut pas que ça devienne un peu complexe de s'y retrouver dans trop de liens et d'infos. Pas d'avis tranché donc.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
J'ai créé une section "Examples of Geotrek-rando portals" avec 4 randos + un montage d'images pour illustrer.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
pour les liens de l'admin je n'ai rien fait pour l'instant, pas trop d'idée sur la façon de les présenter dans le readme.