Skip to content

Commit 4778613

Browse files
committed
Clarify the nature of the Docker alternative and add links
Importantly this pushes this option to being secondary and clarifies which of the build steps it replaces. Note that this also removes the instructions on how to use Docker. If users are not already familiar with Docker & Docker Compose then they are equally not equipped to judge the security posture that it presents.
1 parent da55b3f commit 4778613

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,6 @@ The Student Robotics public documentation.
44

55
## Getting Started
66

7-
For ease of setup, a Docker container is provided. Simply install Docker and `docker-compose`, and run `docker-compose up`.
8-
9-
Once setup, the site will be accessible on http://localhost:4000/docs/
10-
11-
### Manual
12-
137
0. [Clone this repo][clone-repo]
148

159
1. [Install Ruby][install-ruby]
@@ -28,6 +22,14 @@ Once setup, the site will be accessible on http://localhost:4000/docs/
2822

2923
4. View the website at <http://localhost:4000/docs/>
3024

25+
### Docker
26+
27+
If you would prefer to [install Docker][install-docker] and [Docker Compose][install-docker-compose]
28+
rather than Ruby directly, these can be used instead.
29+
30+
Note that this approach exposes the development server to the network you're
31+
using, which may present a security risk.
32+
3133
## Making changes
3234
3335
When you've made a change, either push it to a forked repository, or to a
@@ -58,6 +60,8 @@ page titles.
5860

5961
[clone-repo]: https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository
6062
[install-ruby]: https://www.ruby-lang.org/en/documentation/installation/
63+
[install-docker]: https://docs.docker.com/engine/install/
64+
[install-docker-compose]: https://docs.docker.com/compose/install/
6165
[raise-a-pr]: https://github.com/srobo/docs/pull/new/master
6266
[cspell]: https://cspell.org/
6367
[vscode-cspell]: https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker

0 commit comments

Comments
 (0)