Skip to content

docs: improve documentation#312

Merged
ravisuhag merged 9 commits intomainfrom
docs-improvement
Nov 7, 2022
Merged

docs: improve documentation#312
ravisuhag merged 9 commits intomainfrom
docs-improvement

Conversation

@haveiss
Copy link
Contributor

@haveiss haveiss commented Oct 26, 2022 •
edited
Loading

  • Documentation Update
    • Add config reference for server and client configs
    • Update roadmap with upcoming long term and short features of Guardian
    • Add contribution guide for adding a new provider
    • Create a concept guide for appeal, policy, and providers. Update diagrams for better representation.
    • Add usage examples of fields in the reference section of appeal, policy, and provider.
    • Add deployment guide using helm, docker
    • Update architecture guide

@vercel
Copy link

vercel bot commented Oct 26, 2022 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
guardian ✅ Ready (Inspect) Visit Preview Nov 7, 2022 at 5:14AM (UTC)

@coveralls
Copy link

coveralls commented Oct 26, 2022 •
edited
Loading

Pull Request Test Coverage Report for Build 3407734092

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 74.662%
Totals Coverage Status
Change from base Build 3407013414: 0.0%
Covered Lines: 6026
Relevant Lines: 8071
💛 - Coveralls

@haveiss haveiss marked this pull request as ready for review November 7, 2022 04:43
@mabdh
Copy link
Member

mabdh commented Nov 7, 2022

@haveiss should the commit prefix be docs instead of chore ?

@haveiss haveiss changed the title chore(docs): improve documentation docs: improve documentation Nov 7, 2022
@haveiss
Copy link
Contributor Author

haveiss commented Nov 7, 2022

@haveiss should the commit prefix be docs instead of chore ?

@mabdh sure, done 🙏

@ravisuhag ravisuhag merged commit 08d19f7 into main Nov 7, 2022
@ravisuhag ravisuhag deleted the docs-improvement branch November 7, 2022 19:46
@ravisuhag ravisuhag linked an issue Nov 8, 2022 that may be closed by this pull request
Improve documentation #292
Open
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ravisuhag ravisuhag Awaiting requested review from ravisuhag ravisuhag is a code owner

@rahmatrhd rahmatrhd Awaiting requested review from rahmatrhd rahmatrhd is a code owner

@AkarshSatija AkarshSatija Awaiting requested review from AkarshSatija AkarshSatija is a code owner

@mabdh mabdh Awaiting requested review from mabdh mabdh is a code owner

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Improve documentation

4 participants

@haveiss @coveralls @mabdh @ravisuhag