Skip to content
Snippets Groups Projects
index.md 1.48 KiB
Newer Older
  • Learn to ignore specific revisions
  • Bastien DUMONT's avatar
    Bastien DUMONT committed
    # Self Data Docs
    
    
    Hugo NOUTS's avatar
    Hugo NOUTS committed
    ![selfdata](/img/docshome.png){: .center}
    
    Hugo NOUTS's avatar
    Hugo NOUTS committed
    
    
    Hugo NOUTS's avatar
    Hugo NOUTS committed
    This documentation covers the technical aspects of projects developed by the Grandlyon in cooperation with [Cozy Cloud](https://cozy.io/fr/).
    
    Hugo NOUTS's avatar
    Hugo NOUTS committed
    
    
    In order to work with a self-data environment, there are a couple of prerequisites.
    
    Hugo NOUTS's avatar
    Hugo NOUTS committed
    
    
    Bastien DUMONT's avatar
    Bastien DUMONT committed
    ## Resources
    
    Hugo NOUTS's avatar
    Hugo NOUTS committed
    
    
    Bastien DUMONT's avatar
    Bastien DUMONT committed
    ### Grandlyon resources
    
    Hugo NOUTS's avatar
    Hugo NOUTS committed
    
    
    Don't forget to take a look at our wiki describing general development guidelines [wiki](https://forge.grandlyon.com/web-et-numerique/factory/wiki_web_num). It covers all the processes and guidelines towards developers.
    
    Hugo NOUTS's avatar
    Hugo NOUTS committed
    
    
    Bastien DUMONT's avatar
    Bastien DUMONT committed
    ### Cozy resources
    
    Hugo NOUTS's avatar
    Hugo NOUTS committed
    
    
    Bastien DUMONT's avatar
    Bastien DUMONT committed
    Link                               | Details
    ---------------------------------- | --------
    [Cozy docs](https://docs.cozy.io/en/) | Full technical documentation for all cozy libraries.
    [Mattermost](https://mattermost.cozycloud.cc/) | Chat app for exchange between G.Lyon & Cozy.
    
    Hugo NOUTS's avatar
    Hugo NOUTS committed
    
    ## Contributing to the documentation
    
    
    Bastien DUMONT's avatar
    Bastien DUMONT committed
    ### Clone the project
    
    
    To install and run the documentation on your laptop, follow the steps in the [README](https://forge.grandlyon.com/web-et-numerique/factory/llle_project/self-data-technical-doc). Then:
    
    Hugo NOUTS's avatar
    Hugo NOUTS committed
    
    - Create a branch for your change
    - Add documentation pages to `docs`, and supporting assets to `img`.
    - Write some [markdown](https://guides.github.com/features/mastering-markdown/)
    - Submit a merge request
    
    
    Bastien DUMONT's avatar
    Bastien DUMONT committed
    ### Click the edit button
    
    Click the edit button at the very top, commit to a new branch and open a merge request.
    
    
    ![europe](/img/partners/europe.png){: .inline-center-left}
    
    Bastien DUMONT's avatar
    Bastien DUMONT committed
    ![auvergne](/img/partners/auvergne.png)