publicdata/j40-cejst-2
1
0
Fork 0
mirror of https://github.com/DOI-DO/j40-cejst-2.git synced 2025-02-23 10:04:18 -08:00
Code Issues Projects Releases Packages Wiki Activity Actions
j40-cejst-2/docs/README.md

8 lines
622 B
Markdown
Raw Normal View History

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
# Justice40 Project Documentation
Added readme information under /docs about building and prerequisites (#126) Co-authored-by: Gina Maini <gina.maini@cms.hhs.gov>
2021-06-17 15:44:41 -04:00
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
If you are new to this project, check out the [top level README](/README.md) first.
Added readme information under /docs about building and prerequisites (#126) Co-authored-by: Gina Maini <gina.maini@cms.hhs.gov>
2021-06-17 15:44:41 -04:00
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
The content under this directory should be more about conceptually understanding the project, such as [architecture diagrams](architecture), [decision logs](decisions), and the [Open Source Community Orientation](/docs/Justice40_Open_Source_Community_Orientation.pptx), rather than about specific installation steps.
Added readme information under /docs about building and prerequisites (#126) Co-authored-by: Gina Maini <gina.maini@cms.hhs.gov>
2021-06-17 15:44:41 -04:00
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
For documentation related to installation and getting set up as a developer or data scientist, see [For Developers and Data Scientists](/README.md#for-developers-and-data-scientists).
Reference in a new issue Copy permalink