diff options
| author | Mike Jang <mjang@gitlab.com> | 2019-11-27 00:44:53 +0300 |
|---|---|---|
| committer | Evan Read <eread@gitlab.com> | 2019-11-27 00:44:53 +0300 |
| commit | 0e62ed6d9f39fa9bedf7efc6edd628b137fa781a (patch) | |
| tree | 6d028e25656d717f495f31e8cfef3fe5980b4375 /README.md | |
| parent | 982efbd5033b72d7a1818a2b9ff03ff7ea2fdc51 (diff) | |
Deemphasize GDK as a doc build tool
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 12 |
1 files changed, 6 insertions, 6 deletions
@@ -2,8 +2,8 @@ # GitLab Documentation -This project hosts the repository which is used to generate the GitLab -documentation website and is deployed to https://docs.gitlab.com. It uses the +This project hosts the repository used to generate the GitLab +documentation website and deployed to https://docs.gitlab.com. It uses the [Nanoc](http://nanoc.ws) static site generator. You will not find any GitLab docs content here. All documentation files are @@ -142,10 +142,6 @@ Now let's make Bundler deal with the dependencies defined in the bundle install ``` -## Development under GDK - -See [how to preview the docs changes locally using the GitLab Development Kit](https://gitlab.com/gitlab-org/gitlab-development-kit/blob/master/doc/howto/gitlab_docs.md). - ## Development when contributing to GitLab documentation This section is about contributing to one of GitLab's @@ -288,6 +284,10 @@ Now, open your mobile's browser and type `http://192.168.0.105:3000`, and you sh be able to navigate through the docs site. This process applies to previewing the docs site on every device connected to your network. +### Preview on the GitLab Development Kit + +Alternatively, you can preview changes using the GitLab Development Kit (GDK). For more information, see [Setting up GitLab Docs](https://gitlab.com/gitlab-org/gitlab-development-kit/blob/master/doc/howto/gitlab_docs.md) in the GDK repository. + ## Contributing to the docs website itself If you want to just contribute to the docs website, and not the content, you |