[WIP] Docker docs #6846
[WIP] Docker docs #6846
Conversation
|
|
||
|
|
||
| .. _docker#assumptions: | ||
|
|
There was a problem hiding this comment.
Nit: Only one blank line between anchor and the related title.
| ---------- | ||
|
|
||
| You can optionally use a virtualenv to install the python requirements. This | ||
| will make it easier to install and run as a user other than ``root`` |
| docker. | ||
|
|
||
| As the docker compose configuration is stored in the pootle directory, you will | ||
| need ``git`` installed and ``pip`` for some minimal python dependencies to get |
There was a problem hiding this comment.
These are command so please highlight them using :command:`git` .
| @@ -30,16 +30,46 @@ Pootle. Teams can manage their files, permissions, projects, and translate | |||
| on-line. Files can be downloaded for offline translation. | |||
|
|
|||
|
|
|||
| Installation | |||
| Getting started | |||
There was a problem hiding this comment.
IMHO this might be confusing. Can it be renamed to something like "Trying Pootle" or something in that way?
There was a problem hiding this comment.
Also, are we no longer pointing to install instructions for users that want to got directly to install instead of test run?
There was a problem hiding this comment.
i think basically the following
- abbreviated "getting started" in README
- longer getting started in docs
- page/s with discussion on using dev images (running tests, building assets etc)
- page/s with discussion on running in production
its gonna take some time to get all this done tho
There was a problem hiding this comment.
Ok, as long as the README has some links to those expanded use cases at the bottom of its "Getting started" section.
|
|
||
| .. _docker#virtualenv: | ||
|
|
||
| Create a virtualenv (optional) |
There was a problem hiding this comment.
IMHO I wouldn't make it optional. When giving instructions it is better to reduce the number of optional things so when someone has to provide support it has less paths to explore.
There was a problem hiding this comment.
i think i agree - just that many seem to ignore this.
There was a problem hiding this comment.
Then whoever is providing support can tell them "We can't help you unless you follow the instructions which are well-tested and work."
| .. code-block:: console | ||
|
|
||
| $ mkvirtualenv pootle | ||
| $ cd ~/virtualenvs/pootle |
| --------------------------- | ||
|
|
||
| You most likely want to clone *your* fork of the pootle repository, so you | ||
| can easily create Pull Requests for your changes. |
There was a problem hiding this comment.
I would rephrase to enforce developers using their fork. But for people doing a test run having a fork in place is not mandatory.
|
|
||
| .. _docker#clone: | ||
|
|
||
| Clone the pootle repository |
There was a problem hiding this comment.
Nit: Pootle, starting with uppercase.
| .. code-block:: console | ||
|
|
||
| (pootle): git clone [email protected]:$USER/pootle | ||
| (pootle): cd pootle/ |
There was a problem hiding this comment.
In the console examples I think that the lines should start with (pootle) $ .
| Install the pootle database | ||
| --------------------------- | ||
|
|
||
| The default installer will create a postgresql database with |
|
|
||
| (pootle): makey install-dev | ||
|
|
||
| This will take some time as it loads the default projects |
| Run the development server | ||
| -------------------------- | ||
|
|
||
| Once Pootle is installed you can run the development server with |
|
@qguv i think probably yes. At very least it needs to be rebased, but i think it would be good to clear at least some of the nits too. My other concern is im not clear if these docs are (still) correct without going through and checking them. |
|
ive rebased it at least - ill look at clearing some of the nits... |
Add docs explaing dev and demo installs, and updating the README