set up github pages site

NCEAS / eml

Ecological Metadata Language (EML)

https://eml.ecoinformatics.org/

GNU General Public License v2.0

42 stars 15 forks source link

set up github pages site #321

Closed mbjones closed 5 years ago

mbjones commented 6 years ago

Use a github pages site for the main site for displaying the specification.

Currently this is rendering at https://nceas.github.io/eml

mbjones commented 6 years ago

TODO:

[x] restructure build.xml to generate the full EML spec in html format along with all markdown files converted to html with Jekyll

mbjones commented 6 years ago

Decided to restructure the EML Spec as a bookdown book.

mbjones commented 6 years ago

The current spec has been partially refactored into Markdown, and is now being built as a bookdown book. The chapters of the book are controlled by the file docs/_bookdown.yml, which lists the markdown chapters to be included and their order.

The book is built using R using either bookdown::render_book('index.Rmd') or rmarkdown::render_site(), both of which can be run from within RStudio using the Build tab of the provided emldocs.Rproj.

Still need to finish reorganizing the chapters and modularizing them, but at this point most content has been moved to Markdown. Also need to resolve the differences and redundancy of the README.md and the Chapter 1 of the prior spec, as both are now included in the book.

TODO:

[x] Reorganize book chapters with better flow and transitions
[x] Eliminate redundancy between README and other chapters

mbjones commented 5 years ago

Book output has been moved to the dist directory, and the structure is now complete. We also are now auto-generating the associated schema documentation files using oxygen via the script build_schema_documentation.sh, which creates html files for the schema docs in dist/schema. Still need to link in the docs to the book.

I also created a deploy_site.sh script to push the site to GitHub to the gh_pages branch for publication on GitHub pages.

TODO:

[x] link schema docs into bookdown
[x] set up the eml.ecoinformatics.org CNAME for the GitHub pages site

mbjones commented 5 years ago

I have now set up the site to be published at https://eml.ecoinformatics.org/, using the process described in https://eml.ecoinformatics.org/about-this-site.html. The site publication is handled by Netlify because that allows us to publish our gh_pages branch for a GutHub project without the naming restrictions of GitHub pages.

Schema files are now linked into the book as well, but currently inside an iframe. Need to decide if we want to change this to link to an external page outside of an iframe.