Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

GitBook PR process #327

Merged
merged 7 commits into from
Sep 17, 2020
Merged

GitBook PR process #327

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b3efa58
GitBook: [mt-gitbook-instructions] one page and 46 assets modified
michel-tricot Sep 17, 2020
daf3b35
GitBook: [mt-gitbook-instructions] one page modified
michel-tricot Sep 17, 2020
7a7342b
remove stuf
michel-tricot Sep 17, 2020
812ceb0
remove
michel-tricot Sep 17, 2020
865b5da
GitBook: [mt-gitbook-instructions] no pages and 46 assets modified
michel-tricot Sep 17, 2020
27d347c
GitBook: [mt-gitbook-instructions] one page modified
michel-tricot Sep 17, 2020
f337a54
remove files
michel-tricot Sep 17, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 9 additions & 5 deletions docs/contributing/contributing-to-dataline/updating-documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ Our documentation uses [GitBook](https://gitbook.com) and all the [Markdown](htt

There are 3 different ways you can update the documentation.

## `Edit on GitHub`
## `Edit on GitHub` button

On the page you want to update, just click the `Edit on GitHub` link in the right column. That will get you directly to the file on GitHub that you need to modify. You can use their editor to update the file. Once you're satisfied with your change you can submit a PR.

We recommend that method for changes limited to one file \(typo, updates\).

## Clone repository
## Clone the repository

```bash
$ git clone git@github.com:datalineio/dataline.git
Expand All @@ -22,11 +22,15 @@ If you're adding new files, don't forget to update `docs/SUMMARY.md`.

Once you're satisfied with your changes just follow the regular PR process.

## GitBook
## Edit on GitBook

You can edit the documentation on GitBook. You will able to use their convenient WYSIWYG editor.
To update with GitBook, follow these instructions:

All the changes you make on GitBook will be automatically synced with GitHub once they get reviewed.
1. Create a [new variant](https://docs.gitbook.com/editing-content/variants#create-a-variant). This will create a branch on [GitHub](https://github.com/datalineio/dataline) with the name of the variant
2. Modify the documentation in that new variant
3. Save & merge regularly
4. Once you're satisfied go on [GitHub](https://github.com/datalineio/dataline) and create a PR for your variant branch
5. Once reviewed it will be merge to our master documentation

Just [contact us](mailto:hey@dataline.io) and we will invite you to our space.