Skip to content

Update wiki with instructions for developing using Docker #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bergjohan opened this issue Aug 6, 2023 · 4 comments
Open

Update wiki with instructions for developing using Docker #5

bergjohan opened this issue Aug 6, 2023 · 4 comments

Comments

@bergjohan
Copy link
Contributor

bergjohan commented Aug 6, 2023

The following works on Linux. We should probably verify it on Windows and macOS before adding it to the wiki:

Install Docker:
See https://www.docker.com/

Clone the repository:
$ git clone [email protected]:include-cpp/include-cpp.github.io.git

Make sure the Docker service is running.

Run the site:
$ cd include-cpp.github.io/
$ docker compose up

You should see something like:
include-cppgithubio-web-1 | Server address: http://0.0.0.0:4000
include-cppgithubio-web-1 | Server running... press ctrl-c to stop.

Enter the server address in a browser to see the site running.

Update the site:
Add a title in index.md and save it.
Refresh the site in your browser. You should now see the new title.

@claremacrae
Copy link
Contributor

I have just tested these instructions on an Apple Silicon Mac.

The only other thought I had about the instructions is that most people will need to fork the repo, and clone the fork...

@claremacrae
Copy link
Contributor

This wiki page is mostly still correct then, and it even mentions opening localhost..

https://github.com/include-cpp/include-cpp.github.io/wiki/Developing-the-Site

@bergjohan
Copy link
Contributor Author

Right, what’s missing is instructions on installing Docker and running the Docker service, and running docker compose up, instead of having to install and setup Jekyll on your machine.

@claremacrae
Copy link
Contributor

I checked and I don't have permission to edit the Wiki page - so I hope the info above is useful and someone else can edit it....

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants