Skip to content
Snippets Groups Projects
mkdocs.yml 4.38 KiB
Newer Older
  • Learn to ignore specific revisions
  • site_name: Developer Guide
    #site_description: Portail Data Project Documentation with Markdown.
    site_author: Métropole de Lyon
    
    ddamiron's avatar
    ddamiron committed
    theme:
    
      custom_dir: "custom-material-theme"
    
      language: en
    
    ddamiron's avatar
    ddamiron committed
      palette:
    
        primary: dark-blue
        accent: dgl-red
    
      font:
        text: Titillium Web
        code: Roboto Mono
      logo: "/assets/images/logo.png"
    
    FORESTIER Fabien's avatar
    FORESTIER Fabien committed
      favicon: "/assets/images/favicon.png"
    
      feature:
        tabs: false
    
    ncastejon's avatar
    ncastejon committed
    extra_css: [extra.css]
    
    
    ddamiron's avatar
    ddamiron committed
    markdown_extensions:
    
      - plantuml_markdown:
          server: http://www.plantuml.com/plantuml
    
      - Home: index.md
      - Overview: overview/index.md
      - Architecture: architecture/index.md
      - Components:
    
          - Core Components:
    
              - Legacy AUTH: components/core/legacy-auth.md
    
              - Web App:
                  - Overview: components/custom-apps/web-app/overview.md
                  - Homepage: components/custom-apps/web-app/homepage.md
                  - Changelog: components/custom-apps/web-app/changelog.md
                  - Feedback: components/custom-apps/web-app/feedback.md
                  - Reuses: components/custom-apps/web-app/reuses.md
                  - Partners: components/custom-apps/web-app/partners.md
                  - Credits: components/custom-apps/web-app/credits.md
                  - Static pages: components/custom-apps/web-app/static-pages.md
                  - Dataset:
    
                      - Details: components/custom-apps/web-app/dataset/dataset-detail.md
    
                      - Data: components/custom-apps/web-app/dataset/data.md
                      - Information: components/custom-apps/web-app/dataset/info.md
    
                      - API: components/custom-apps/web-app/dataset/api.md
                      - Downloads: components/custom-apps/web-app/dataset/downloads.md
    
                  - Header: components/custom-apps/web-app/header.md
                  - Footer: components/custom-apps/web-app/footer.md
                  - Drafts: components/custom-apps/web-app/drafts.md
                  - Side Menu: components/custom-apps/web-app/side-menu.md
                  - User management: components/custom-apps/web-app/user-management.md
                  - Contact: components/custom-apps/web-app/contact.md
                  - Search: components/custom-apps/web-app/search.md
              - Admin GUI: components/custom-apps/admin-gui.md
    
    Alessandro Cerioni's avatar
    Alessandro Cerioni committed
          - Off-the-shelf applications:
    
              - API Gateway: components/off-the-shelf-apps/api-gateway.md
              - Headless CMS: components/off-the-shelf-apps/cms.md
              - Search Engine: components/off-the-shelf-apps/elasticsearch.md
    
    Alessandro Cerioni's avatar
    Alessandro Cerioni committed
          - Middlewares:
    
              - Legacy AUTH: components/middlewares/legacy-auth.md
    
              - Web mapping services: components/proxies/query.md
    
              - Maintenance page: components/miscellaneous/maintenance-page.md
    
    Alessandro Cerioni's avatar
    Alessandro Cerioni committed
          - Indexers:
    
              - Metadata and Data: components/indexers/metadata-and-data.md
              - Editorial Content: components/indexers/editorial-content.md
    
              - Authentication: components/services/authentication.md
              - Changelog: components/services/changelog.md
              - Credits: components/services/credits.md
              - Reuses: components/services/reuses.md
              - CSV Catalog Downloader: components/services/csv-catalog-downloader.md
              - Mailer: components/services/mailer.md
              - Media Library: components/services/media-library.md
              - Organizations: components/services/organizations.md
              - Resources helper: components/services/resources-helper.md
              - Social media share helper: components/services/social-media-share-helper.md
    
              - Minio master-slave mirror: components/tools/minio-master-slave-mirror.md
      - Administration: administration/admin-tools.md
      - Deployment:
    
    Alessandro Cerioni's avatar
    Alessandro Cerioni committed
          - 2019 deployment of the first public beta version: deployment/beta-deployment.md
    
      - Monitoring: monitoring/monitoring.md
      - Other:
    
    Alessandro Cerioni's avatar
    Alessandro Cerioni committed
          - Security: miscellaneous/security.md
          - NestJS-based micro-services: miscellaneous/nestjs-micro-services.md
          - Accessibility: miscellaneous/accessibility.md
          - AUTHN & AUTHZ: miscellaneous/authentication&authorization.md
    
          - Gitflow: miscellaneous/gitflow-ci-cd.md
          - VSCode: miscellaneous/vscode-settings.md
          - SASS recommendation: miscellaneous/sass-recommendation.md
          - Webapp-auth: miscellaneous/webapp-auth.md
    
    Alessandro Cerioni's avatar
    Alessandro Cerioni committed
          - Multi-environment docker build for Angular app: miscellaneous/multi-environments-docker-build-for-angular.md