Skip to content
This repository was archived by the owner on Dec 5, 2023. It is now read-only.

Commit ddb9fbd

Browse files
author
Etienne Tremel
committed
Remove dev config, add instruction on how to get started
1 parent d257ab8 commit ddb9fbd

File tree

4 files changed

+13
-22
lines changed

4 files changed

+13
-22
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
1-
This directory contains the deployment and internal documentation.
1+
microservices-demo documentation
2+
================================
23

3-
Both are published on https://microservices-demo.github.io/microservices-demo/.
4+
> This directory contains the deployment and internal documentation.
5+
It is published at [microservices-demo.github.io](https://microservices-demo.github.io)
46

5-
There is a docker-compose included for local development. Note that it mounts `_config.yml.dev` in the place of `_config.yml`, to enable local linking.
7+
8+
## Getting started
9+
10+
There is a [docker-compose](https://docs.docker.com/compose/) included for
11+
local development, use the following command to start it:
12+
13+
```
14+
docker-compose up
15+
```

_config.yml

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
1-
# Production settings
2-
3-
baseurl: ""
4-
deploy_doc_url_prefix: https://microservices-demo.github.io/microservices-demo
5-
main_url_prefix: https://microservices-demo.github.io
6-
71
# Build settings
82
markdown: kramdown
93
exclude:

_config.yml.dev

Lines changed: 0 additions & 12 deletions
This file was deleted.

docker-compose.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,3 @@ services:
1313
- 4000:4000
1414
volumes:
1515
- .:/srv/jekyll
16-
- $PWD/_config.yml.dev:/srv/jekyll/_config.yml

0 commit comments

Comments
 (0)