Commit d4b05836 authored by Thomas Boni's avatar Thomas Boni
Browse files

reorganize getting started section

parent 698e8c41

docs/concept.md

0 → 100644
+20 −0
Original line number Diff line number Diff line 
# Concept



The **Go2Scale HUB** is a collaborative hub of CI & CD

**ready to use** jobs which helps you to easily build powerful pipelines for your

projects.



!!! info

    Currently, the hub is focused to provides only **Gitlab 🦊** jobs. We plan

    to support more CI/CD platforms in the future.



Each jobs of the hub can be used unitary to create fully **customs pipelines.**

You can use them for any kind of software and deployment type. Each job can be

customized through configuration.



* 🚀 Start using jobs from the hub: [Use the HUB](/use-the-hub)

* 🙋 Contribute to the hub: [Contributing](/contributing)



## Overview



![HUB overview](images/g2shub_mvp.png)

docs/setup.md→docs/use-the-hub.md

+1 −1
Original line number Diff line number Diff line 
# Setup

# Use the HUB



## 📝 Prerequisites

mkdocs.yml

+11 −10
Original line number Diff line number Diff line 
# Project information

site_name: Go2Scale hub

site_name: Go2Scale HUB

site_description: 'Ready to use CI/CD Jobs for your Pipelines !'

site_author: 'Go2Scale <cto@go2scale.com>'

site_url: 'https://go2scale.gitlab.io/hub/'
@@ -15,16 +15,12 @@ Copyright &copy; 2020 Go2Scale 
repo_name: 'go2scale/hub'

repo_url: 'https://gitlab.com/go2scale/hub'



# Landing page

landing_page:

  title: 'Welcome to the Go2Scale hub ! 🎉'

  description: 'Collaborative hub of CI & CD ready to use jobs which helps you to quickly build powerful pipelines for your projects'



# Navigation

nav:

  - Home: index.md

  - Getting started:

    - Setup: setup.md

    - Concept: concept.md

    - Use the HUB: use-the-hub.md

    - Versioning: versioning.md

    - Contributing: contributing.md

    - License: license.md
@@ -33,8 +29,13 @@ nav: 


# Customization

extra:



  # Landing page

  landing_page:

    title: 'Create powerful CI/CD pipelines, easily'

    description: 'Use this collection of ready-to-use jobs to quickly create amazing pipelines for your projects. Simply select your jobs, we take care of the rest. Enjoy it after a 10-minutes setup.'



  social:

  # TODO: update with Go2Scale social networks

    - icon: 'fontawesome/brands/discord'

      link: 'https://discord.gg/5QKpGqR'

    - icon: 'fontawesome/solid/globe'
@@ -55,7 +56,7 @@ theme: 
  custom_dir: 'overrides'

  # Color

  palette:

    primary: 'indigo' # choose: https://squidfunk.github.io/mkdocs-material/getting-started/#primary-colors

    primary: 'indigo'

    accent: 'indigo'

  # Text

  language: 'en'
@@ -70,7 +71,7 @@ theme: 
    - navigation.tabs

    - navigation.instant



# Extensions (https://squidfunk.github.io/mkdocs-material/extensions/admonition/)

# Extensions (https://squidfunk.github.io/mkdocs-material/reference/abbreviations/)

markdown_extensions:

  - attr_list

  - admonition # block-styled content (note, idea, warning, ...)