Commit 27b1a175 authored by Mathis Raguin's avatar Mathis Raguin Committed by Mathis
Browse files

add: contributing


Signed-off-by: Mathis Raguin's avatarMathis Raguin <mathis.raguin@epita.fr>
parent 6daca0f7
# Documentation
If you find an error on our documentation or find that a useful page is missing,
please create an issue or a pull request on
[epita-doc](https://github.com/epita/epita-doc) GitHub page.
# Map
## What are SM Maps
A map is a simple SVG file. This means that you can easily modify it to match
the real building structure or the room layout.
The only requirements is that each computer is a `rect` with the following
properties are set:
- `class`: `computer`
- `id`: the hostname of the computer. Underscore must be replace with dots. (e.g.
`r01p01_demo_sm_cri_epita_net`)
## Create or edit a map
Although not required, `inkscape` is recommended to design a map.
A simple `demo.svg` map is provided. It is recommended to edit it rather than
creating a map from scratch.
### Add a computer
Copying an existing computer with `inkscape` will provide every properties
required except `id`.
You may resize it if required.
### Resize and export
If your map renders properly only on `inkscape`, the `viewBox` might be invalid.
`inkscape` provides a way to export your work so that it fills the whole space
available. To do so, you have to export it using `Save As` > `Optimized SVG` and
check `Enable viewboxing`.
This will automatically resize the viewbox and provide a much more readable
(and shorted) output.
While this is great for production, the contributed maps MUST be on a format
easily editable. It does not matter if the `viewBox` is wrong as it will be
exported later for production.
## Links
Every maps (including `demo.svg` and `demo_optimized.svg`) are available on the
CRI's github: [here](https://github.com/epita/FIXME).
site_name: EPITA - Documentation
theme: readthedocs
repo_url: https://github.com/epita/epita-doc/
markdown_extensions:
- admonition
pages:
- Home: 'index.md'
- Documentation:
......@@ -14,4 +16,8 @@ pages:
- Accounts:
- Cri and Bocal accounts: 'accounts.md'
- Recover and modify passwords: 'passwords.md'
- Contributing:
- 'map_contributing.md'
- 'doc_contributing.md'
- Contact: 'contact.md'
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment