WAI site TF/Technicalities
[draft]
Requirements
- Relatively easy editing for WAI staff and other editors
- @@
CMS?
Pro:
- Easy to use
- Consistent navigation
- Allows for quick updates, potentially with little Team involvement
Cons:
- Would probably not work well with the GitHub workflow
- Needs to be maintained and updated
- Does not allow the freedom of arbitrary document structures
Maybe using a CMS for news/frequently changed content, but not for documents?
Custom CMS?
Another idea would be to have a custom CMS that pulls the information from the various repositories (on demand) but would also allow some very EO specific functionality, like the comparison of documents (diffs), supporting multiple versions ect. The development of the resources would still be on Github, but the organization of the navigation and updating would be on the CMS.
I think this is probably the most realistic approach to be honest, and I think I want to investigate this more.
Every document needs to be in an overall navigation concept. It depends what approach we use for the different resources. If they are relatively stand alone, it might make sense to only have a very light overall navigation and provide portal-like access.
Static resources on GitHub
(This applies to resources in development; we won't put all resources on GitHub.)
Technical plan for building static-ish resources:
- Every resource that is developed on GitHub has its own
wai-[shortname]GitHub repository. - This repository is a fork a base repository [to be created]
- In the repository there is a
_config.yamlwhich enables Jekyll. - Also there is a base structure for the resources, including sub-repositories that point to central JS and CSS files.
- Add a configuration option that allows easy export for putting generated files on the W3C server, with correct paths for the W3C server and intact links.
- In the repository there is a