Skip to content
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

review of the setup document & fix typos in ld article #53

Merged
merged 2 commits into from Aug 8, 2022

Conversation

pvgenuchten
Copy link
Contributor

i aligned the layout with other pages and updated some of the text/snippets
@justb4, what do you think

@pvgenuchten pvgenuchten requested a review from justb4 August 4, 2022 16:41
Copy link
Member

@justb4 justb4 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I approve for the json-ld.md, but have some comments (see the line-based) on setup/index.md.

workshop/content/docs/setup/index.md Show resolved Hide resolved
workshop/content/docs/setup/index.md Show resolved Hide resolved
Here we override the default configuration which resides at `/pygeoapi/local.config.yml` within the Container
with our local file [default.config.yml](https://github.com/geopython/pygeoapi/blob/master/docker/default.config.yml)
by using Docker Volume Mount (`-v` option). A Docker Volume mount attaches, 'mounts', a
In the upcoming exercises we are going to update the configuration file multiple times.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, in reality there is already a pygeoapi config in the workshop materials (now under docker/pygeoapi/docker.config.yml) which is mounted via docker-compose and modified in the exercises.
Suggestion is to mount that file in this exercise here.

Also think we should have a Docker Compose with that file mounted in this section as to prepare for "first.md"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it could also make sense to first run directly on a container, before going into the compose use case

fix typos in ld article
@pvgenuchten pvgenuchten force-pushed the local_links branch 5 times, most recently from c4d5a33 to 4b78e61 Compare August 7, 2022 12:47
!!! question "Docker in the background"

1. Type `docker-compose up -d`
1. Type `docker ls`; verify that the pygeoapi container is running
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wrong earlier: must be docker ps

[Docker Compose](https://docs.docker.com/compose/) is an addition to Docker to facilitate
the orchestration of one or more Docker 'Containers' (a Container is a running instance of a Docker Image)
[Docker Compose](https://docs.docker.com/compose/) is an addition to docker to facilitate
the orchestration (configuration) of one or more Docker 'Containers' (a Container is a running instance of a docker image)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here 'Docker Image` (and Container) all capitalized.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Image and Container not sure, they are not names; check at https://en.wikipedia.org/wiki/Docker_(software), they use image and container

@justb4 justb4 self-requested a review August 7, 2022 13:35
Copy link
Member

@justb4 justb4 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See my inline comments, mainly to use capitals..

Ok, in the Setup section, indeed may download the config file from the pygeoapi GH repo, for demonstrating how to mount a config file, and use the '-e' option.

@pvgenuchten
Copy link
Contributor Author

updated to use Docker capitalised

@pvgenuchten pvgenuchten requested a review from justb4 August 8, 2022 08:37
@justb4
Copy link
Member

justb4 commented Aug 8, 2022

Indeed product names like Docker Compose capitalised, but artefacts like 'image' and 'container' lowercase.

@justb4 justb4 merged commit 654bc23 into geopython:main Aug 8, 2022
@pvgenuchten
Copy link
Contributor Author

we may have to fix Compose then (other pr)

@pvgenuchten pvgenuchten deleted the local_links branch August 8, 2022 12:33
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

Successfully merging this pull request may close these issues.

None yet

2 participants