Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
D
documentation
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
web-et-numerique
web-et-numerique-internet
data.grandlyon.com
web-portal
documentation
Commits
f5ecde18
Commit
f5ecde18
authored
5 years ago
by
Nicolas Castejon
Browse files
Options
Downloads
Plain Diff
Merge branch 'mkdocs_material' into 'master'
update README file See merge request refonte-data/documentation!2
parents
eeb6b4ae
cdc36338
No related branches found
No related tags found
1 merge request
!2
update README file
Pipeline
#1035
passed
5 years ago
Stage: build
Stage: deploy
Changes
3
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
README.md
+32
-1
32 additions, 1 deletion
README.md
docs/index.md
+0
-30
0 additions, 30 deletions
docs/index.md
mkdocs.yml
+6
-1
6 additions, 1 deletion
mkdocs.yml
with
38 additions
and
32 deletions
README.md
+
32
−
1
View file @
f5ecde18
# Portail Data documentation
\ No newline at end of file
# Portail Data documentation
## Commands
*
`mkdocs new [dir-name]`
- Create a new project.
*
`mkdocs serve`
- Start the live-reloading docs server.
*
`mkdocs build`
- Build the documentation site.
*
`mkdocs help`
- Print this help message.
## Setting files hierarchy
inside mkdocs.yml use the key nav: to configure the md files hierarchy
nav:
- Home: index.md
- Architecture Guide:
- Admin-gui: architecture/admin-gui.md
- Admin-tools: architecture/admin-tools.md
- Api-gateway: architecture/api-gateway.md
- CMS: architecture/cms.md
- Monitoring: architecture/monitoring.md
- Web-app: architecture/web-app.md
- Service:
- authentification: architecture/service/autentification.md
- Elasticsearch:
- Indexer: architecture/service/elasticsearch/indexer.md
## Project layout
mkdocs.yml # The main file and configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
\ No newline at end of file
This diff is collapsed.
Click to expand it.
docs/index.md
+
0
−
30
View file @
f5ecde18
# Welcome to the functional documentation of portail-data
## Commands
*
`mkdocs new [dir-name]`
- Create a new project.
*
`mkdocs serve`
- Start the live-reloading docs server.
*
`mkdocs build`
- Build the documentation site.
*
`mkdocs help`
- Print this help message.
## Setting files hierarchy
inside mkdocs.yml use the key nav: to configure the md files hierarchy
nav:
- Home: index.md
- Architecture Guide:
- Admin-gui: architecture/admin-gui.md
- Admin-tools: architecture/admin-tools.md
- Api-gateway: architecture/api-gateway.md
- CMS: architecture/cms.md
- Monitoring: architecture/monitoring.md
- Web-app: architecture/web-app.md
- Service:
- authentification: architecture/service/autentification.md
- Elasticsearch:
- Indexer: architecture/service/elasticsearch/indexer.md
## Project layout
mkdocs.yml # The main file and configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
This diff is collapsed.
Click to expand it.
mkdocs.yml
+
6
−
1
View file @
f5ecde18
...
...
@@ -4,6 +4,9 @@ site_author: MkDocs Team
theme
:
name
:
'
material'
palette
:
primary
:
'
grey'
accent
:
'
amber'
nav
:
-
Home
:
index.md
...
...
@@ -15,7 +18,9 @@ nav:
-
Monitoring
:
architecture/monitoring.md
-
Web-app
:
architecture/web-app.md
-
Service
:
-
authentification
:
architecture/service/autentification.md
-
authentification
:
architecture/service/authentication.md
-
organizations
:
architecture/service/organizations.md
-
resources
:
architecture/service/resources.md
-
Elasticsearch
:
-
Indexer
:
architecture/service/elasticsearch/indexer.md
-
About
:
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment