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

move docs to github/docs #19

Closed
6 tasks done
pvgenuchten opened this issue Jun 2, 2021 · 3 comments
Closed
6 tasks done

move docs to github/docs #19

pvgenuchten opened this issue Jun 2, 2021 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request high priority

Comments

@pvgenuchten
Copy link
Collaborator

pvgenuchten commented Jun 2, 2021

in stead of running it as a service, let git-action deploy as html on geonovum.github.io/ogc-api-testbed/docs

By @justb4:

Yes, in addition it is quite easy to run "docs" as a GitHub Pages flat HTML website in its own domain. We use this e.g. for pygeoapi.io and tv.osgeo.nl . So this needs to be done:

  • move docs from services/docs to GH root /docs
  • make new service "home" that is just a one-page index.md landing page with links to the services and the new docs site, make required Ansible and Actions changes
  • DNS: create a CNAME entry e.g. apitestdocs.geonovum.nl that refers to geonovum.github.io
  • GitHub create GH Pages entry with CNAME
  • GitHub add GH Action file to publish docs to GitHub, use pygeoapi.io main.yml as starter
  • anything else? See https://github.com/geopython/pygeoapi.io

Advantages:

  • docs are always available even when VPS-es gone
  • single authoritative place for documentation (i.s.o. both in stable and sandbox servers)
@justb4 justb4 added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 15, 2021
@thijsbrentjens
Copy link
Member

good proposal, I'll asl for a CNAME entry

@thijsbrentjens
Copy link
Member

CNAME entry should be there: apitestdocs.geonovum.nl --> geonovum.github.io

justb4 added a commit that referenced this issue Jun 21, 2021
justb4 added a commit that referenced this issue Jun 21, 2021
justb4 added a commit that referenced this issue Jun 22, 2021
justb4 added a commit that referenced this issue Jun 22, 2021
justb4 added a commit that referenced this issue Jun 22, 2021
@justb4
Copy link
Contributor

justb4 commented Jun 22, 2021

done

@justb4 justb4 closed this as completed Jun 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request high priority
Projects
None yet
Development

No branches or pull requests

3 participants