Update getting started docs #3871
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
brainwane
suggested changes
May 1, 2018
docs/development/getting-started.rst
Outdated
|
|
||
| Warehouse needs access to a few local ports in order to run, namely ports | ||
| ``80``, ``5433``, and ``9000``. You can check if a port is in use by running | ||
| the following command (in this example, checking port ``80``: |
There was a problem hiding this comment.
You have a missing ) here.
docs/development/getting-started.rst
Outdated
| the web container is listening on port 80. It's accessible at | ||
| ``http://localhost:80/``. | ||
| This means that all the services are up, and web container is listening on port | ||
| 80. It's accessible at ``http://localhost:80/``. |
There was a problem hiding this comment.
I suggest we make http://localhost:80/ a clickable link.
docs/development/getting-started.rst
Outdated
|
|
||
| If the port is in use, the command will produce output, and you will need to | ||
| determine what is occupying the port and shut down the service. Otherwise, the | ||
| port is available for Warehouse to use, and you can continue. |
There was a problem hiding this comment.
I think either this should be in the troubleshooting section, or we should phrase this instruction more imperatively:
Check each of those three port numbers with
lsof.
|
@brainwane Addressed your feedback. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This fixes some of the issues listed at https://public.etherpad-mozilla.org/p/issues-from-sprint, namely:
make servecommandmake initdbcommandCloses #2673, closes #3861.