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-07 17:49:40 +0300
committerConnor Shea <connor.james.shea@gmail.com>2016-10-07 17:49:40 +0300
commit031a641e04ab4f97ccacb10d07b6309e2ecdfb18 (patch)
treef70e35bc71c085312365dc4dcaf2020c9c296918 /README.md
parent1a070bebce261bb6163490c13149e255deae91f3 (diff)
Add checklist to README.md.
Diffstat (limited to 'README.md')
-rw-r--r--README.md42
1 files changed, 20 insertions, 22 deletions
diff --git a/README.md b/README.md
index 257640a1..a6d66af4 100644
--- a/README.md
+++ b/README.md
@@ -34,29 +34,29 @@ This will host the site at `localhost:3000`. Changes will be reloaded automatica
## Requirements/Goals
-- Feature parity with the existing [docs.gitlab.com](https://docs.gitlab.com/)
-- Use GitLab CI / GitLab Pages for compilation, deployment, and hosting of the Documentation site.
-- Sections for Community Edition, Enterprise Edition, GitLab CI, and Omnibus.
-- 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.
-- Link to "Edit on GitLab.com" for every page to encourage contribution.
-- Auto-generated documentation structure based on YML frontmatter.
-- Responsive design.
+- [ ] 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.
+- [ ] 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.
+- [ ] Link to "Edit on GitLab.com" for every page to encourage contribution.
+- [ ] Responsive design.
### Nice-to-haves
-- Some way to embed/package the site inside the Rails app so the documentation can be included with the application itself. This would be nice for users behind firewalls, etc. This _should not_ be handled by Rails itself, as that causes all kinds of problems. It should just be a set of static pages.
-- Some way to export the documentation as PDF/ePub for use offline.
-- Future-proofing for internationalization.
-- Tests for working internal links and such. (Nanoc includes this by default!)
-- Automated screenshots! (Not really directly related, but I still want it.)
-- A blog post explaining how we do all this using GitLab, GitLab CI, and GitLab Pages, as well as all open source tools.
-- Auto-generated Table of Contents for every page.
-- Anchor links for every page section.
-- Syntax highlighting with Rouge.
-- Version dropdown that links to the current page for that version (if it exists).
+- [ ] Some way to embed/package the site inside the Rails app so the documentation can be included with the application itself. This would be nice for users behind firewalls, etc. This _should not_ be handled by Rails itself, as that causes all kinds of problems. It should just be a set of static pages.
+- [ ] Some way to export the documentation as PDF/ePub for use offline.
+- [ ] Future-proofing for internationalization.
+- [ ] Tests for working internal links and such. (Nanoc includes this by default!)
+- [ ] Automated screenshots! (Not really directly related, but I still want it.)
+- [ ] A blog post explaining how we do all this using GitLab, GitLab CI, and GitLab Pages, as well as all open source tools.
+- [ ] Auto-generated Table of Contents for every page.
+- [ ] Anchor links for every page section.
+- [x] Syntax highlighting with Rouge.
+- [ ] Auto-generated documentation structure based on YML frontmatter.
+- [ ] Version dropdown that links to the current page for that version (if it exists).
## Implementation details
@@ -109,8 +109,6 @@ This is almost definitely out of the question due to how bloated the repository
- Use artifacts to store previous versions of the site so they don't have to be regenerated constantly.
- Nanoc is supposedly quite fast.
-### Versioning
-
### Differentiating between CE and EE features
One potential problem with having separate docs for CE vs. EE is the inability to easily track differences between the two. Their documentation won't necessarily be kept in-sync and pages that differ between CE and EE may cause conflicts when merging the CE repository into EE.