Commit graph

10 commits

Author SHA1 Message Date
Neil Martinsen-Burrell
1b241a6587 Documentation updates and an index of the documentation 2025-01-16 14:11:17 -06:00
Travis Newby
c3a68cb251
[SPIKE] Improve backend documentation (#2177)
* Update code owners to include new folks and remove the departed ones

* Update maintainers to reflect the current personnel

* Update contributing with the latest, and make small changes to readme to make it easier to read

* Update maintainers with Lucas Brown

* Update installation guide to refine instructions and make them easier to follow

* Try emojis to make notes stand out more

* Experiment with note

* Moved installation of data pipeline into a new file (contents TBD), and redid most part of the data pipeline README for clarity and readability

* Add mermaid diagram

* Fix table

* Update readme for clarity and correctness

* Update TOC

* Fix comparator doc

* Add section on internal score comparison

* Move tox information from installation to testing

* Update installation for data pipeline

* Add emojis to make picking out platform-specific instructions easier

* Fix Git caps

* Update for readability

* Add direct link to VS Code instructions

* Fix broken link and improve readability

* Update installation for clarity and proper case

* Update python text

* Clean up information about poetry and poetry lockfiles

* Remove duplicate paragraph

* Fix case

* update date table

* re-adjust table to put links at the end

* Fix a few minor typos

---------

Co-authored-by: Sam Powers <121890478+sampowers-usds@users.noreply.github.com>
2023-02-28 15:11:57 -06:00
Vim
6ba17b544d
Update documentation from OS contributors (#1657)
* Update documentation from OS contributors

* Disable markdown links checks for certain links

* Disable expired links
2022-05-27 15:17:17 -07:00
Vim
ba3c370c53
Update file with branching naming (#1188) 2022-01-27 07:58:57 -08:00
Shaun Verch
d90e028c1b
Update documentation to make it easier for users to find the right content for them (#1016)
* First pass of updating documentation for new users

Trying to look at this from the perspective of someone new to the
project, and create some pathways to make it easier for people to get to
the content they are looking for.

* Make it clear that docker is doing the setup

* Link installation again from the main README

* Add some docs about the github actions

* Add markdown link check

* Move git installation first

* Add config for markdown link checker

* Fix some links

* Correct handling of repo root relative links

* Fix broken links in data roadmap

* Fix more broken links

* Fix more links

* Ignore link that's returning a 403 to the checker

It actually works if you go in a browser.

* Fix another broken link

* Ignore more urls that don't work

* Update the readme under docs

* Add some more dataset links

* More strongly call out the quickstart

* Try to call out even more the quickstart link

* Fix dead links

* Add note about initialization time

* Remove broken link from spanish install guide

These will be updated later with a full translation
2021-12-16 10:16:28 -05:00
Shelby Switzer
774fe2d522
Add translations for repo documents (#281)
* WIP README improvements

* Add translations for some core open source process files

This addresses #37. Note that these translations were requested from the
State Dept a few weeks ago, so they don't have some of the latest
updates to content from recent PRs. We will need to come up with a good
proces for keeping both sets of docs up to date as we make changes.

Co-authored-by: Shelby Switzer <shelby.switzer@cms.hhs.gov>
2021-07-01 13:48:03 -04:00
Jorge Escobar
cd06100925
Adding fork methodology to contributions (#106) 2021-06-07 12:23:31 -04:00
Nat Hillard
be98e2e82d Typo 2021-05-07 10:06:36 -04:00
Nat Hillard
d890ff64ca updating CONTRIBUTING 2021-05-06 15:00:49 -04:00
Shelby Switzer
6217b2acf0 Add contribution info and license
* Uses CDCGov projects like PRIME as well as Atom and 18f github orgs
for inspiration
* Does not have a CoC yet (need more research here)
* Could use some more details fleshed out on how to contribute code and
what that process is, but this warrents some more discussion
2021-05-05 10:27:01 -04:00