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

Pull content of docusaurus in README #109

Open
cfisher-scottlogic opened this issue Nov 14, 2023 · 1 comment
Open

Pull content of docusaurus in README #109

cfisher-scottlogic opened this issue Nov 14, 2023 · 1 comment
Assignees
Labels
spike Investigative work

Comments

@cfisher-scottlogic
Copy link

cfisher-scottlogic commented Nov 14, 2023

Background

Dev documentation in the project README has been updated with #83 and #99. The docusaurus should also be updated with this information. The files for this are maintained with version control in finos-vuu/docs. The README and the docusaurus are not currently linked. Maintaining two identical copies of documentation is inefficient and opens the door for both versions to become out of sync with each other. Ideally, the documentation visible in the GitHub README and the docusaurus site will have the same source code. so documentation only needs to be amended once to propagate to both sites.

Work Required

  • Investigate a way of coalescing the README.md and documentation located in finos-vuu/docs

Outcome

  • a list of files from finos-vuu/docs/ that we want to include in our finos-vuu/README.md
  • Approach/es on how to generate a README.md from multiple markdown files
  • Proof of Concept

Notes

  • All information in the README should be in the docusaurus. Not all information in the docusaurus needs to be in the README.
  • layout server and workspace settings docs are only in README at the moment. We need to pull those in docs.
@cfisher-scottlogic cfisher-scottlogic added this to the Layout Management milestone Nov 14, 2023
@cfisher-scottlogic cfisher-scottlogic changed the title pull content of docs in README Pull content of docusaurus in README Nov 14, 2023
@cfisher-scottlogic cfisher-scottlogic added the spike Investigative work label Nov 14, 2023
@pling-scottlogic pling-scottlogic self-assigned this Nov 21, 2023
@pling-scottlogic
Copy link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
spike Investigative work
Projects
None yet
Development

No branches or pull requests

2 participants