GitBook: [master] 21 pages and 2 assets modified

Author: Victor Coisne

LICENSE.md

@@ -1,45 +1,34 @@
-<a href="https://www.sourced.tech">
-  <img src="docs/assets/sourced-community-edition.png" alt="source{d} Community Edition (CE)" height="120px" />
-</a>
+# Introduction
 
-**source{d} Community Edition (CE) is the data platform for your software development life cycle.**
+ [![](docs/.gitbook/assets/sourced-community-edition.png)](https://www.sourced.tech)
 
-[![GitHub version](https://badge.fury.io/gh/src-d%2Fsourced-ce.svg)](https://github.com/src-d/sourced-ce/releases)
-[![Build Status](https://travis-ci.com/src-d/sourced-ce.svg?branch=master)](https://travis-ci.com/src-d/sourced-ce)
-![Beta](https://svg-badge.appspot.com/badge/stability/beta?color=D6604A)
-[![Go Report Card](https://goreportcard.com/badge/github.com/src-d/sourced-ce)](https://goreportcard.com/report/github.com/src-d/sourced-ce)
-[![GoDoc](https://godoc.org/github.com/src-d/sourced-ce?status.svg)](https://godoc.org/github.com/src-d/sourced-ce)
+**source{d} Community Edition \(CE\) is the data platform for your software development life cycle.**
 
-[Website](https://www.sourced.tech) •
-[Documentation](https://docs.sourced.tech/community-edition) •
-[Blog](https://blog.sourced.tech) •
-[Slack](http://bit.ly/src-d-community) •
-[Twitter](https://twitter.com/sourcedtech)
+[![GitHub version](https://badge.fury.io/gh/src-d%2Fsourced-ce.svg)](https://github.com/src-d/sourced-ce/releases) [![Build Status](https://travis-ci.com/src-d/sourced-ce.svg?branch=master)](https://travis-ci.com/src-d/sourced-ce) ![Beta](https://svg-badge.appspot.com/badge/stability/beta?color=D6604A) [![Go Report Card](https://goreportcard.com/badge/github.com/src-d/sourced-ce)](https://goreportcard.com/report/github.com/src-d/sourced-ce) [![GoDoc](https://godoc.org/github.com/src-d/sourced-ce?status.svg)](https://godoc.org/github.com/src-d/sourced-ce)
 
+[Website](https://www.sourced.tech) • [Documentation](https://docs.sourced.tech/community-edition) • [Blog](https://blog.sourced.tech) • [Slack](http://bit.ly/src-d-community) • [Twitter](https://twitter.com/sourcedtech)
 
-![source{d} CE dashboard](docs/assets/dashboard.png)
+![source{d} CE dashboard](docs/.gitbook/assets/dashboard.png)
 
 ## Introduction
 
-**source{d} Community Edition (CE)** helps you to manage all your code and engineering data in one place:
+**source{d} Community Edition \(CE\)** helps you to manage all your code and engineering data in one place:
 
-- **Code Retrieval**: Retrieve and store the git history of the code of your organization as a dataset.
-- **Analysis in/for any Language**: Automatically identify languages, parse source code, and extract the pieces that matter in a language-agnostic way.
-- **History Analysis**: Extract information from the evolution, commits, and metadata of your codebase and from GitHub, generating detailed reports and insights.
-- **Familiar APIs**: Analyze your code through powerful SQL queries. Use tools you're familiar with to create reports and dashboards.
-
-This repository contains the code of **source{d} Community Edition (CE)** and its project documentation, which you can also see properly rendered at [docs.sourced.tech/community-edition](https://docs.sourced.tech/community-edition).
+* **Code Retrieval**: Retrieve and store the git history of the code of your organization as a dataset.
+* **Analysis in/for any Language**: Automatically identify languages, parse source code, and extract the pieces that matter in a language-agnostic way.
+* **History Analysis**: Extract information from the evolution, commits, and metadata of your codebase and from GitHub, generating detailed reports and insights.
+* **Familiar APIs**: Analyze your code through powerful SQL queries. Use tools you're familiar with to create reports and dashboards.
 
+This repository contains the code of **source{d} Community Edition \(CE\)** and its project documentation, which you can also see properly rendered at [docs.sourced.tech/community-edition](https://docs.sourced.tech/community-edition).
 
 ### Contents
 
-- [Introduction](#introduction)
-- [Quick Start](#quick-start)
-- [Contributing](#contributing)
-- [Community](#community)
-- [Code of Conduct](#code-of-conduct)
-- [License](#license)
-
+* [Introduction](./#introduction)
+* [Quick Start](./#quick-start)
+* [Contributing](./#contributing)
+* [Community](./#community)
+* [Code of Conduct](./#code-of-conduct)
+* [License](./#license)
 
 ## Quick Start
 
@@ -48,21 +37,22 @@ This repository contains the code of **source{d} Community Edition (CE)** and it
 To run it you only need:
 
 1. To have Docker installed in your PC
-1. Download `sourced` binary (for your OS) from [our releases](https://github.com/src-d/sourced-ce/releases)
-1. Run it:
+2. Download `sourced` binary \(for your OS\) from [our releases](https://github.com/src-d/sourced-ce/releases)
+3. Run it:
+
    ```bash
    $ sourced init orgs --token=<github_token> <github_org_name>
    ```
-   And log in into http://127.0.0.1:8088 with login: `admin`, and password: `admin`.
 
-If you want more details of each step, you will find in the [**Quick Start Guide**](docs/quickstart/README.md) all the steps to get started with **source{d} CE**, from the installation of its dependencies to running SQL queries to inspect git repositories.
+   And log in into [http://127.0.0.1:8088](http://127.0.0.1:8088) with login: `admin`, and password: `admin`.
 
-If you have any problem running **source{d} CE** you can take a look at out [Troubleshooting](docs/troubleshooting.md) section, and our [source{d} Forum](https://forum.sourced.tech), where you can also ask for help when using **source{d} CE**. If you spotted a bug, or have a feature request, please [open an issue](https://github.com/src-d/sourced-ce/issues) to let us know abut it.
+If you want more details of each step, you will find in the [**Quick Start Guide**](docs/quickstart/) all the steps to get started with **source{d} CE**, from the installation of its dependencies to running SQL queries to inspect git repositories.
 
+If you have any problem running **source{d} CE** you can take a look at our [Troubleshooting](docs/learn-more/troubleshooting.md) section, and our [source{d} Forum](https://forum.sourced.tech), where you can also ask for help when using **source{d} CE**. If you spotted a bug, or have a feature request, please [open an issue](https://github.com/src-d/sourced-ce/issues) to let us know about it.
 
 ## Architecture
 
-_For more details on the architecture of this project, read [docs/architecture.md](docs/architecture.md)._
+_For more details on the architecture of this project, read_ [_docs/architecture.md_](docs/learn-more/architecture.md)_._
 
 **source{d} CE** is deployed as Docker containers, using Docker Compose.
 
@@ -72,34 +62,29 @@ The main entry point of **source{d} CE** is [sourced-ui](https://github.com/src-
 
 The data exposed by the web interface is prepared and processed by the following services:
 
-- [babelfish](https://doc.bblf.sh): universal code parser.
-- [gitcollector](https://github.com/src-d/gitcollector): fetches the git repositories owned by your organization.
-- [ghsync](https://github.com/src-d/ghsync): fetches metadata from GitHub (users, pull requests, issues...).
-- [gitbase](https://github.com/src-d/gitbase): SQL database interface to Git repositories.
-
+* [babelfish](https://doc.bblf.sh): universal code parser.
+* [gitcollector](https://github.com/src-d/gitcollector): fetches the git repositories owned by your organization.
+* [ghsync](https://github.com/src-d/ghsync): fetches metadata from GitHub \(users, pull requests, issues...\).
+* [gitbase](https://github.com/src-d/gitbase): SQL database interface to Git repositories.
 
 ## Contributing
 
-[Contributions](https://github.com/src-d/sourced-ce/issues) are **welcome and very much appreciated** 🙌
-Please refer to [our Contribution Guide](docs/CONTRIBUTING.md) for more details.
-
+[Contributions](https://github.com/src-d/sourced-ce/issues) are **welcome and very much appreciated** 🙌 Please refer to [our Contribution Guide](docs/learn-more/contributing.md) for more details.
 
 ## Community
 
 source{d} has an amazing community of developers and contributors who are interested in Code As Data and/or Machine Learning on Code. Please join us! 👋
 
-- [Community](https://sourced.tech/community/)
-- [Slack](http://bit.ly/src-d-community)
-- [Twitter](https://twitter.com/sourcedtech)
-- [Email](mailto:[email protected])
-
+* [Community](https://sourced.tech/community/)
+* [Slack](http://bit.ly/src-d-community)
+* [Twitter](https://twitter.com/sourcedtech)
+* [Email](mailto:[email protected])
 
 ## Code of Conduct
 
-All activities under source{d} projects are governed by the
-[source{d} code of conduct](https://github.com/src-d/guide/blob/master/.github/CODE_OF_CONDUCT.md).
-
+All activities under source{d} projects are governed by the [source{d} code of conduct](https://github.com/src-d/guide/blob/master/.github/CODE_OF_CONDUCT.md).
 
 ## License
 
-GPL v3.0, see [LICENSE](LICENSE.md).
+GPL v3.0, see [LICENSE](docs/learn-more/license.md).
+

README.md

@@ -1,28 +1,33 @@
-* [Quickstart](./quickstart/README.md)
-    - [Dependencies](./quickstart/1-install-requirements.md)
-    - [Install **source{d} CE**](./quickstart/2-install-sourced.md)
-    - [Run **source{d} CE**](./quickstart/3-init-sourced.md)
-    - [Explore Your Data](./quickstart/4-explore-sourced.md)
+# Table of contents
+
+* [Introduction](../README.md)
+* [Quickstart](quickstart/README.md)
+  * [Dependencies](quickstart/1-install-requirements.md)
+  * [Install source{d} CE](quickstart/2-install-sourced.md)
+  * [Run source{d} CE](quickstart/3-init-sourced.md)
+  * [Explore Your Data](quickstart/4-explore-sourced.md)
 
 ## Usage
-* [sourced Command Reference](./usage/commands.md)
-* [Multiple Datasets](./usage/multiple-datasets.md)
-* [SQL Examples](./usage/examples.md)
-* [Babelfish UAST](./usage/bblfsh.md)
+
+* [sourced Command Reference](usage/commands.md)
+* [Multiple Datasets](usage/multiple-datasets.md)
+* [SQL Examples](usage/examples.md)
+* [Babelfish UAST](usage/bblfsh.md)
 
 ## Learn More
 
-* [FAQ](./faq.md)
-* [Troubleshooting](./troubleshooting.md)
-* [Architecture](./architecture.md)
-* [Contribute](./CONTRIBUTING.md)
-* [License](../LICENSE.md)
+* [FAQ](learn-more/faq.md)
+* [Troubleshooting](learn-more/troubleshooting.md)
+* [Architecture](learn-more/architecture.md)
+* [Contribute](learn-more/contributing.md)
+* [License](learn-more/license.md)
 
-### Resources
+## Resources
 
 * [GitHub Repository](https://github.com/src-d/sourced-ce)
 * [Product Page](https://www.sourced.tech)
 * [Book a Demo](https://go.sourced.tech/community-demo)
 * [Get in Touch With Us](http://go.sourced.tech/contact)
 * [Join Us on Slack](https://sourced-community.slack.com/join/shared_invite/enQtMjc4Njk5MzEyNzM2LTFjNzY4NjEwZGEwMzRiNTM4MzRlMzQ4MmIzZjkwZmZlM2NjODUxZmJjNDI1OTcxNDAyMmZlNmFjODZlNTg0YWM)
 * [source{d} Forum](https://forum.sourced.tech)
+