guardian icon indicating copy to clipboard operation
guardian copied to clipboard

docs: update documentation

Open Chief-Rishab opened this issue 2 years ago • 7 comments

  • [ ] Documentation for the Provider plugins
    • [x] Add No-Op Provider
    • [x] Update BigQuery
    • [ ] Update Metabase
    • [ ] Update GCS
    • [ ] Update Grafana
    • [x] Update GCloud IAM
  • [x] Add Server Jobs Reference
  • [x] Add descriptions with examples on the API reference page
  • [x] Update Introduction

Chief-Rishab avatar Aug 25 '22 15:08 Chief-Rishab

Pull Request Test Coverage Report for Build 3295052749

  • 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.039%

Totals Coverage Status
Change from base Build 3280619429: 0.0%
Covered Lines: 5952
Relevant Lines: 8039

💛 - Coveralls

coveralls avatar Aug 25 '22 15:08 coveralls

@Chief-Rishab this has been stale for a long time, any progress for this?

mabdh avatar Sep 21 '22 07:09 mabdh

mas @mabdh I can start working on it now, was a bit occupied earlier

Chief-Rishab avatar Sep 21 '22 07:09 Chief-Rishab

@ravisuhag the more feature we develop the more likely for a doc of one of this component to be irrelevant. Should we split this documentation into several issues instead? cc @rahmatrhd @Chief-Rishab

mabdh avatar Sep 23 '22 09:09 mabdh

@mabdh yes, we can do one thing. I will complete the docs for provider plugins which are the first in the list of to-do's in the description and merge in the main branch. After that we can go and add the new branches for the development guide, and architecture separately since it might be a larger story altogether and add to main branch as we complete

Chief-Rishab avatar Sep 23 '22 09:09 Chief-Rishab

@Chief-Rishab thank you! can you please also create separate issues for the rest 🙏🏼 ?

mabdh avatar Sep 26 '22 04:09 mabdh

@abduh created three issues for updating the documentation. Will complete this and mark for review

Chief-Rishab avatar Sep 27 '22 04:09 Chief-Rishab

@Chief-Rishab I am merging this PR to unblock folks on updating other parts of docs. You can raise another PR for pending things on docs from your side.

ravisuhag avatar Oct 21 '22 14:10 ravisuhag