Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-docs.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorConnor Shea <connor.james.shea@gmail.com>2016-10-09 04:02:28 +0300
committerConnor Shea <connor.james.shea@gmail.com>2016-10-09 04:02:28 +0300
commit963ad6a1601740a3e99d8ad99cab4895ce1cbd32 (patch)
tree1e10152ca99953e571dfb40e79de81f57b68fc46 /README.md
parent973361a9893706e44dc9ec1d4beb0d470f60deea (diff)
Cache gems in CI, update README a bit.
Diffstat (limited to 'README.md')
-rw-r--r--README.md5
1 files changed, 3 insertions, 2 deletions
diff --git a/README.md b/README.md
index a6d66af4..e14b63a1 100644
--- a/README.md
+++ b/README.md
@@ -21,6 +21,7 @@ This will host the site at `localhost:3000`. Changes will be reloaded automatica
- [GitHub Developer Site](https://github.com/github-archive/developer.github.com)
- [Spree Guides](https://github.com/spree/spree/tree/master/guides)
- [Atom Flight Manual](https://github.com/atom/flight-manual.atom.io)
+- [Prometheus Docs](https://github.com/prometheus/docs)
### Good Documentation
@@ -37,10 +38,10 @@ This will host the site at `localhost:3000`. Changes will be reloaded automatica
- [ ] Feature parity with the existing [docs.gitlab.com](https://docs.gitlab.com/)
- [x] Use GitLab CI / GitLab Pages for compilation, deployment, and hosting of the Documentation site.
- [x] Sections for Community Edition, Enterprise Edition, GitLab CI, and Omnibus.
-- [ ] Pull documentation from the repositories mentioned above.
+- [x] Pull documentation from the repositories mentioned above.
- [ ] Versioned documentation (e.g. switch between documentation for 9.0, 9.1, 9.2, 9.3, "latest", etc.)
- [ ] Automatically generated API documentation.
-- [ ] Search the documentation, can probably use existing Documentation search functionality.
+- [ ] Search the documentation (Can either re-use existing Documentation search functionality or implement search using Algolia or something else? Ideally simple and open source, but it doesn't really matter too much.)
- [ ] Link to "Edit on GitLab.com" for every page to encourage contribution.
- [ ] Responsive design.