X-Git-Url: https://jfr.im/git/irc/freenode/web-7.0.git/blobdiff_plain/5eeaa3140c4fd9acb7d1e9684f252f0f2951ab55..7b38f6bda31a444dfb42a0e7e13d7731a3023252:/README.md diff --git a/README.md b/README.md index a82bc5915..a2dadddbe 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ A shiny replacement for http://freenode.net. You'll need our node.js dependencies: ```console -$ npm install -g myth svgo +$ sudo npm install -g myth svgo ``` Then, assuming a Python 3.4 (or later) installation: @@ -43,7 +43,7 @@ result in by navigating to `https://github.com/freenode/web-7.0/tree/pull/XYZ/merge`, where `XYZ` is the pull request number. -You can also go to `https://freenode.github.io/web-7.0/BRANCHNAME/` to see a +You can also go to `https://freenode.net/web-7.0/BRANCHNAME/` to see a build of any particular branch. This also works for *internal* pull requests (they are named `pull-X`). @@ -62,12 +62,12 @@ cms7 will document this process, but for now: `page.html`. - `content/news/` contains blog/news posts which are rendered in `out/news/` using `article.html`. -- `content/faq/` contains FAQ categories: each directory `content/faq/X/` - has the entries for category `X`. These are rendered in `out/faq/answers/` - with `faq.html`. +- `content/kb/` contains KB categories: each directory `content/kb/X/` + has the entries for category `X`. These are rendered in `out/kb/answers/` + with `kb.html`. - Indexes of these entries are rendered in `out/faq/` with `faq_index.html`, - according to a list in `config/faq.yml`. + Indexes of these entries are rendered in `out/kb/` with `kb_index.html`, + according to a list in `config/kb.yml`. ### Markdown metadata @@ -97,12 +97,12 @@ generally its name is derived from the name of the *input*. relative to the repository root: `static/img/cat.jpg`. - Templates that are rendered from nothing (e.g. to make the index page) are named whatever the config file says to name them. -- FAQ indexes are named `faq/index/X`, where X is the name of the index in - `config/faq.yml`. +- KB indexes are named `kb/index/X`, where X is the name of the index in + `config/kb.yml`. cms7 can generate a relative URL to anything with a name from any page. This should always be preferred over manually writing links. To generate a relative -link from a Markdown template, just link to a name: +link from a Markdown document, just link to a name: ```markdown [A page about frogs](pages/frog) @@ -113,16 +113,3 @@ To do the same from a template, call `url_for`: ```html+jinja A page about frogs ``` - - -## TODO -- [ ] Get the basic static page up, and how to connect (latest two news about - the reformation + about page, kinda) scheduled release: 2016-02-29 - - [x] Design ready enough - - [x] Preprocessor ready - - [x] Templates ready enough - - [ ] Content ready -- [ ] FAQ pages structure, start adding FAQ's (note: tagging could be a good thing for searching and finding) -- [ ] Add possibility to edit on-site integrated with services (log in with your nickserv acc) -- [ ] Gms integration -- [ ] Further development TODO: TODO