Skip to content

Commit

Permalink
[docs]: Update landing page of the docs site (#100)
Browse files Browse the repository at this point in the history
* be specific about contributions

* remove "Next Steps" tab and doc

* add link to Discussions for other queries

* fix typo

* add Next Steps section to home page

* add link to contribution guidelines to home page

* create new tab for Data Models
  • Loading branch information
vpchung authored Apr 26, 2024
1 parent 1785893 commit ae7de75
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 15 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Please read the [Contributing guidelines] on the Data Models Explorer
docs site.
docs site to learn more about how to contribute to the data models.

[Contributing guidelines]: https://mc2-center.github.io/data-models/contributing/
10 changes: 8 additions & 2 deletions docs/contributing.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Thank you for contributing to the MC2 Center data models project! This page
will guide you through our development workflow and data model releases, as
well as how to update this docs site.
will guide you through our development workflow, data model release process,
and how to update this docs site.

### Development process

Expand Down Expand Up @@ -92,10 +92,16 @@ The Data Models Explorer uses [MkDocs], [mkdocs-table-reader-plugin], and the
pip install mkdocs mkdocs-material mkdocs-table-reader-plugin pandas
```

### I want to contribute something else...

If there is something you'd like to contribute that was not covered on this page,
please reach out to us on the [Discussions board]!

[data-models repo]: https://github.com/mc2-center/data-models
[Semantic Versioning]: https://semver.org/
[Releases]: https://github.com/mc2-center/data-models/releases
[MKDocs]: https://www.mkdocs.org/
[mkdocs-table-reader-plugin]: https://timvink.github.io/mkdocs-table-reader-plugin/
[Material theme]: https://squidfunk.github.io/mkdocs-material/
[pandas]: https://pandas.pydata.org/docs/index.html
[Discussions board]: https://github.com/mc2-center/data-models/discussions
22 changes: 18 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,25 @@ project by key, value, or descriptions.

---

### Next Steps

To start contributing to your resources on the Cancer Complexity Knowledge
Portal (CCKP), please read [our CCKP docs].

---

### Found an error?

We are always looking for ways to improve our data models. If there is
an issue with an existing term - or if you have a suggestion - [let us know](https://github.com/mc2-center/data-models/issues/new?assignees=aditigopalan&labels=bug&projects=&template=bug-report.md&title=%5Bbug%5D+)!
an issue with an existing term - or if you have a suggestion - [let us know]!

Or, if you would like to contribute to the project directly, read our
[contribution guidelines].

!!!important
Changing existing terminology may result in breaking changes downstream,
so not all suggestions may be considered unless they are well-justified.

Please note that changing existing terminology may result in breaking
changes downstream, so not all suggestions will be considered unless
they are well-justified.
[our CCKP docs]: https://help.cancercomplexity.synapse.org/doc/contributing-and-updating-data-in-the-portal
[contribution guidelines]: https://mc2-center.github.io/data-models/contributing/
[let us know]: https://github.com/mc2-center/data-models/issues/new?assignees=aditigopalan&labels=bug&projects=&template=bug-report.md&title=%5Bbug%5D+
3 changes: 0 additions & 3 deletions docs/next-steps.md

This file was deleted.

8 changes: 3 additions & 5 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,8 @@ repo_name: data-models

# Navigation
nav:
- Home:
- index.md
- MC2 Center Data Models:
- Home: index.md
- Data Models:
- Dataset Data Model: model/dataset.md
- Education Resource Data Model: model/education.md
- Grant Data Model: model/grant.md
Expand All @@ -27,8 +26,7 @@ nav:
- Person: valid_values/person.md
- Publication: valid_values/publication.md
- Tool: valid_values/tool.md
- Next Steps: next-steps.md
- Contributing: contributing.md
- Contributing to the Data Model: contributing.md

# Theme configuration
theme:
Expand Down

0 comments on commit ae7de75

Please sign in to comment.