docs: simpler readme + add small docs#665
Merged
wesleyboar merged 30 commits intomainfrom Jul 18, 2023
Merged
Conversation
fnets
reviewed
Jul 3, 2023
fnets
approved these changes
Jul 3, 2023
Contributor
fnets
left a comment
There was a problem hiding this comment.
I don't know much about the non-APCD CMS sites, but this makes sense
Member
Author
|
I had been mimicking https://github.com/TACC/Core-Portal README format as closely as possible, but CMS is ready for its own README format, and this documentation update coincides well with https://github.com/TACC/Core-CMS/releases/tag/v3.12.0 and the deprecation of https://github.com/TACC/Core-CMS-Resources 1 and the increasing migration to https://github.com/TACC/Core-CMS-Custom 1. Footnotes |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
Simplify the README. Add supplemental docs.
Related
Changes
/README.mdto be much better/docsto hold README excessTesting
README.mdwithout the diff.UI
N/A