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

set up github pages site #321

Closed
mbjones opened this issue Nov 21, 2018 · 5 comments
Closed

set up github pages site #321

mbjones opened this issue Nov 21, 2018 · 5 comments
Assignees
Labels
Milestone

Comments

@mbjones
Copy link
Contributor

@mbjones mbjones commented Nov 21, 2018

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

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

@mbjones mbjones added this to the EML2.2.0 milestone Nov 21, 2018
@mbjones mbjones self-assigned this Nov 21, 2018
@mbjones

This comment has been minimized.

Copy link
Contributor Author

@mbjones mbjones commented Nov 21, 2018

TODO:

  • restructure build.xml to generate the full EML spec in html format along with all markdown files converted to html with Jekyll
@mbjones

This comment has been minimized.

Copy link
Contributor Author

@mbjones mbjones commented Nov 21, 2018

Decided to restructure the EML Spec as a bookdown book.

mbjones added a commit that referenced this issue Nov 22, 2018
More work to be done to convert the old docbook structure to markdown. See issue #321.
@mbjones

This comment has been minimized.

Copy link
Contributor Author

@mbjones mbjones commented Nov 26, 2018

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:

  • Reorganize book chapters with better flow and transitions
  • Eliminate redundancy between README and other chapters
@mbjones

This comment has been minimized.

Copy link
Contributor Author

@mbjones mbjones commented Aug 13, 2019

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:

  • link schema docs into bookdown
  • set up the eml.ecoinformatics.org CNAME for the GitHub pages site
@mbjones

This comment has been minimized.

Copy link
Contributor Author

@mbjones mbjones commented Aug 16, 2019

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.

@mbjones mbjones closed this Aug 16, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
1 participant
You can’t perform that action at this time.