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

Documentation refresh - user-level documentation #195

Open
TonyWildish-BH opened this issue Nov 8, 2024 · 4 comments
Open

Documentation refresh - user-level documentation #195

TonyWildish-BH opened this issue Nov 8, 2024 · 4 comments
Assignees
Labels
EPIC - SDE environment Bits of Barts needed to make the SDE useful MVP Things that need to be considered for the MVP release

Comments

@TonyWildish-BH
Copy link
Collaborator

No description provided.

@TonyWildish-BH
Copy link
Collaborator Author

TonyWildish-BH commented Nov 8, 2024

The old user-documentation site needs an overhaul, and moving to the new site.

The old docs are at https://github.com/Barts-Life-Science/AzureTRE/wiki, the newer version is at https://github.com/Barts-Life-Science/Barts-Life-Science.github.io

@TonyWildish-BH TonyWildish-BH changed the title Documentation refresh Documentation refresh - user-level documentation Nov 8, 2024
@TonyWildish-BH TonyWildish-BH added MVP Things that need to be considered for the MVP release EPIC - SDE environment Bits of Barts needed to make the SDE useful labels Nov 8, 2024
@BIOKU-BH
Copy link

BIOKU-BH commented Nov 9, 2024

Could you kindly put some description here for my own reference? It helps me stay in line with requirement

@TonyWildish-BH
Copy link
Collaborator Author

We have a lot of user-level docs and admin-level docs in the old site. We need to filter out the user-level docs to a new site, where we can keep it clean.

The github wiki format isn't suitable, it doesn't do hierarchical pages - which is partly why the original site is a mess - so we'll start with moving the user-level docs into the new site.

The new site uses Github Pages, which means you just commit markdown to a repo and the site appears, live and immediate. There are flashier tools out there, but we don't have time to dig into them, and the basic version looks workable.

I've put both our names against this mostly as we should both be familiar with how it's working. I suggest I update the documentation, then tag you to review the pages?

@TonyWildish-BH
Copy link
Collaborator Author

I've updated the documentation, now at https://barts-life-science.github.io/sde/Home.html. Bioku, please review when you have time!

I've noted that one of the screenshots is too small, and needs replacing. That's a separate ticket

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
EPIC - SDE environment Bits of Barts needed to make the SDE useful MVP Things that need to be considered for the MVP release
Projects
None yet
Development

No branches or pull requests

2 participants