diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index df0bbd7..bb5fc32 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -1,7 +1,6 @@ -# Contributing guidelines - -We thank you in advance :thumbsup: :tada: for taking the time to contribute, whether with *code* or with *ideas*, to the NeIC SDA project. +# Contributing Guidelines +We thank you in advance 👍 🎉 for taking the time to contribute, whether with *code* or with *ideas*, to the NeIC SDA project. ## Did you find a bug? @@ -43,7 +42,6 @@ Once the feature is done you can request it to be merged back into `master` by m Before making the pull request it is a good idea to rebase your branch to `master` to ensure that eventual conflicts with the `master` branch is solved before the PR is reviewed and we can therefore have a clean merge. - ### General stuff about git and commit messages In general it is better to commit often. Small commits are easier to roll back and also makes the code easier to review. @@ -100,6 +98,6 @@ If it takes long for some partner to review code we try to contact them on slack Thanks again, /NeIC System Developers -[searching under Issues]: https://github.com/neicnordic/neic-sda/issues?utf8=%E2%9C%93&q=is%3Aissue%20label%3Abug%20%5BBUG%5D%20in%3Atitle -[open a new one]: https://github.com/neicnordic/neic-sda/issues/new?title=%5BBUG%5D -[template to report a bug]: https://github.com/neicnordic/neic-sda/issues/new?template=bug-report.md +[searching under Issues]: https://github.com/neicnordic/sensitive-data-archive/issues?utf8=%E2%9C%93&q=is%3Aissue%20label%3Abug%20%5BBUG%5D%20in%3Atitle +[open a new one]: https://github.com/neicnordic/sensitive-data-archive/issues/new?title=%5BBUG%5D +[template to report a bug]: https://github.com/neicnordic/sensitive-data-archive/issues/new?template=bug-report.md diff --git a/docs/dictionary/wordlist.txt b/docs/dictionary/wordlist.txt index 3813756..47b5eeb 100644 --- a/docs/dictionary/wordlist.txt +++ b/docs/dictionary/wordlist.txt @@ -80,6 +80,7 @@ filepath filesystem fjddcmrvlawqmvrbly formsubmission +funders getarchived getheader getheaderforstableid diff --git a/docs/index.md b/docs/index.md index 63b2e7e..7b49228 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,7 +4,7 @@ NeIC Sensitive Data Archive The NeIC Sensitive Data Archive (SDA) is an encrypted data archive, originally implemented for storage of sensitive biological data. It is implemented as a modular microservice system that can be deployed in different configurations depending on the service needs. -The modular architecture of SDA supports both stand alone deployment of an archive, and the use case of deploying a Federated node in the [Federated European Genome-phenome Archive network (FEGA)](https://ega-archive.org/federated), serving discoverable sensitive datasets in the main [EGA web portal](https://ega-archive.org). +The modular architecture of SDA supports both stand alone deployment of an archive, and the use case of deploying a Federated node in the [Federated European Genome-phenome Archive network (FEGA)](https://ega-archive.org/about/projects-and-funders/federated-ega/), serving discoverable sensitive datasets in the main [EGA web portal](https://ega-archive.org). > NOTE: > Throughout this documentation, we can refer to [Central @@ -44,7 +44,7 @@ The components illustrated can be classified by which archive sub-process they t | Metadata | Component used in standalone version of SDA. Provides an interface and backend to submit Metadata and associated with a file in the Archive. | Submission, Ingestion and Data Retrieval | | Orchestrator | Component used in standalone version of SDA. Provides an automated ingestion and dataset ID and file ID mapping. | Submission, Ingestion and Data Retrieval | -Organisation of the NeIC SDA Operations handbook +Organisation of the NeIC SDA Operations Handbook ------------------------------------------------ This operations handbook is organized in four main parts, that each has it's own main section in the left navigation menu. Here we provide a condensed summary, follow the links below or use the menu navigation to each section's own detailed introduction page: @@ -58,9 +58,6 @@ This operations handbook is organized in four main parts, that each has it's ow 1. **Guides**: Topic-guides for topics like "Deployment", "Federated vs. Standalone", "Troubleshooting services", etc. - - - > NOTE: > NB!!! Content below to be considered moved into introductory pages of STRUCTURE and COMMUNICATION sections: diff --git a/mkdocs.yml b/mkdocs.yml index 7254dc7..ead2ff8 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,4 +1,4 @@ -site_name: NeIC SDA Operations handbook +site_name: NeIC SDA Operations Handbook extra_css: [css/neic-sda.css] markdown_extensions: - callouts