search

Ouranosinc / PAVICS-landing

The landing page serving as the entrance to PAVICS
1 stars 0 forks source link

document deployment requirements and procedures #21

Closed tlvu closed 3 years ago

tlvu commented 3 years ago

In the README https://github.com/Ouranosinc/PAVICS-landing/blob/4df0d47c6ed9a7a43e210a94527765f9846909cc/README.md, it simply says "Run npx http-server src -c-1 to view, or use any other webserver to serve the contents of src folder.".

  1. There is no instruction how to get that npx command (assume a very minimal Docker image, not a full blown desktop installation). If a Docker already image exists with everything required, please let us know!

Also that commands seems to launch a built-in http server.

  1. What would be the command to only "compile" everything but let an external http server do the job of serving the content?
  2. Any special requirements for that external http server?

In a continuous deployment scenario, this git repo will be checkout once, then periodically git pull and run that "compile" command to refresh the output.

  1. Is that "procedure" enough to ensure the content served by the external http server stay up-to-date?
  2. Is there any caching that needs to be invalidated?
  3. Can that "compile" command update a previously existing "output folder" or that output has to be flushed first?

Please update the README or reply here, whatever you think is more appropriate. Trying to automate the continuous deployment to prod using Docker. Thanks !

grassick commented 3 years ago

I've updated the README.md to clarify. There is no compile step at all; the site is served directly from the src folder with no special requirements at all.

For continuous deployment, just do a git pull and there are no other steps.

The npx http-server is simply a convenient way of getting a web server up easily, and python –m http.server from the src folder would work as well.

tlvu commented 3 years ago

@grassick Super! Thanks a lot for the clarification. Makes my job easier now. Linking your commit here for traceability https://github.com/Ouranosinc/PAVICS-landing/commit/7954e9cdb0f57c962496524abe8dc1c5ae9e636d.