Initial set-up for ReadtheDocs documentation for Perseo Front End. #304
Conversation
jason-fox
commented
Nov 20, 2018
jason-fox
commented
- Please create a project on readthedocs called fiware-perseo-fe and point to this repository.
- Includes standard CSS and badges.
- Just a dump of existing documentation but with CSS styling.
- Please create a project on readthedocs called fiware-perseo-fe and point to this repository. - Includes standard CSS and badges. - Just a dump of existing documentation but with CSS styling.
documentation/index.md
Outdated
| @@ -0,0 +1,5 @@ | |||
| # Perseo-FE (EPL server) | |||
There was a problem hiding this comment.
"(EPL Server)" should be removed
mkdocs.yml
Outdated
| site_name: Perseo Front End | ||
| site_url: https://fiware-perseo-fe.readthedocs.org | ||
| repo_url: https://github.com/telefonicaid/perseo-fe.git | ||
| site_description: Perseo-Front End (EPL server) |
There was a problem hiding this comment.
"(EPL Server)" should be removed
|
fiware-perseo-fe project has been created at RTD, although I haven't configured yet automatic integration:
Do you have at hand the howto about this (I'm not fully sure but I remember there were some piece of documentation in FIWARE docs about it...), pls? |
|
Hi Jason, We (Ficodes) created long time ago https://perseo.readthedocs.io for publishing Perseo documentation. We are working on updating existing documentation to reflect recent changes of Perseo, and have them published there. Currently we are working in our own repo (https://github.com/Ficodes/perseo-fe/tree/newdocumentation) to have it all ready for next week FIWARE Summit, but then we will create a PR to telefonica’s repo. Transfering the ownership of this readthedocs page to Telefónica is pending yet. |
|
Thanks @rafitanba for the feedback. I'll hold on the merge of this PR while this gets clarified. I can remove the just created fiware-perseo-fe and fiware-core proyects at RTD if they are inapropiated. |
|
Hi @fgalan. Let's wait for @jason-fox thoughts on this matter, but whatever his answer is, I would have just one Perseo project at RTD including both fe and core documentation. |
|
Currently, most of the documentation is located in perseo-fe repo (and it makes sense). As far as I remember, Perseo Core only includes information about building the component and the minium FE<->Core API. Is possible to configure the same RTD project web-hooked to two different Github repositories? If not possible, having two separarte RTD project (each one associated to a repository) would be feasible. |
I don't think it is, the correct way to do this would be to either have the the components submodules and the docs as a root module or place the docs in one of the two repos and just place a simple link to the published RTD in the other one. I've made the minor mods requested in case you want to merge this. Alternatively take the documentation directly from the FI-Codes docs and add close this PR. |
|
Ficodes (@rafitanba @cblanco @aarranz), what do you think? It would be great if we could progress on the final solution for Perseo documentation in RTD... |
|
A new PR (#330) has been created related with Perseo FE documentation. It overpasses this one? Should this one be closed? |
|
Probably. Let's keep the branch for reference for now and I'll close it. |
