|
|
@ -1,21 +1,17 @@ |
|
|
|
# Welcome to MkDocs |
|
|
|
# Welcome to the COSI Info and Documentation server! |
|
|
|
|
|
|
|
For full documentation visit [mkdocs.org](https://www.mkdocs.org). |
|
|
|
Information about infrastructure, services and about the labs in general can be found throughout the site. |
|
|
|
|
|
|
|
## Commands |
|
|
|
!!! Warning |
|
|
|
|
|
|
|
* `mkdocs new [dir-name]` - Create a new project. |
|
|
|
* `mkdocs serve` - Start the live-reloading docs server. |
|
|
|
* `mkdocs build` - Build the documentation site. |
|
|
|
* `mkdocs -h` - Print help message and exit. |
|
|
|
As this site is under construction, some information may not be present. The most up to date documentation can be found on our [Gitea instance](https://gitea.cosi.clarkson.edu). Older documentation may be found on the [older documentation server](https://docs.cosi.clarkson.edu). |
|
|
|
|
|
|
|
## Project layout |
|
|
|
## Contributing to info/ |
|
|
|
|
|
|
|
mkdocs.yml # The configuration file. |
|
|
|
docs/ |
|
|
|
index.md # The documentation homepage. |
|
|
|
... # Other markdown pages, images and other files. |
|
|
|
COSI is a living-learning community. In order to help lab members (past, present and future) maintain the community, it becomes a necessity to document what each service is and how it works.Contributing to info/ is an ideal way of doing so as it is accessible to everyone from their web browser. |
|
|
|
|
|
|
|
# Test Header |
|
|
|
### How to contribute: |
|
|
|
|
|
|
|
Test paragraph. |
|
|
|
To contribute to info/, make sure you have an LDAP account on the COSI network. If you do not have one, contact an available sysadmin and they will create one for you. |
|
|
|
|
|
|
|
Once you have an LDAP account, clone down the [info-slash repository](https://gitea.cslabs.clarkson.edu/COSI_Sysadmins/info-slash) and make modifications to your local copy. Commit and push your changes to have them be saved to the repository. To deploy your changes, run `mkdocs gh-deploy` and your changes will appear on info/ within 10 minutes. |