Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove GitHub docs in favor of organization level configuration #2210

Merged
merged 2 commits into from
Jun 30, 2021

Conversation

steven-sheehy
Copy link
Member

@steven-sheehy steven-sheehy commented Jun 30, 2021

Detailed description:

  • Add a issue template config.yml since discussions link is project specific
  • Add documentation on use of passwords
  • Fix a line rendering error in deployment diagram
  • Remove GitHub docs in favor of organization level configuration

Which issue(s) this PR fixes:

Special notes for your reviewer:
CONTRIBUTING.md PR still up for review.

Checklist

  • Documentation added
  • Tests updated

Signed-off-by: Steven Sheehy <steven.sheehy@hedera.com>
@steven-sheehy steven-sheehy added documentation Type: Improvements or additions to documentation P2 labels Jun 30, 2021
@steven-sheehy steven-sheehy added this to the Mirror 0.37.0 milestone Jun 30, 2021
@steven-sheehy steven-sheehy requested a review from a team June 30, 2021 16:49
@steven-sheehy steven-sheehy self-assigned this Jun 30, 2021
@codecov
Copy link

codecov bot commented Jun 30, 2021

Codecov Report

❗ No coverage uploaded for pull request base (main@84bb44f). Click here to learn what that means.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #2210   +/-   ##
=======================================
  Coverage        ?   76.57%           
  Complexity      ?      530           
=======================================
  Files           ?      214           
  Lines           ?     6667           
  Branches        ?      543           
=======================================
  Hits            ?     5105           
  Misses          ?     1438           
  Partials        ?      124           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 84bb44f...88b2db1. Read the comment docs.

default**.
## Default Values

The default configuration allows users to get quickly up and running without having to configure anything. This provides
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: reads better I think

Suggested change
The default configuration allows users to get quickly up and running without having to configure anything. This provides
The default configuration allows users to quickly get up and running without having to configure anything. This provides

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated

Signed-off-by: Steven Sheehy <steven.sheehy@hedera.com>
@sonarcloud
Copy link

sonarcloud bot commented Jun 30, 2021

Copy link
Contributor

@Nana-EC Nana-EC left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Collaborator

@xin-hedera xin-hedera left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@steven-sheehy
Copy link
Member Author

I ended up being able to add the link to HIP in the organization level config. So no changes necessary here for that.

@steven-sheehy steven-sheehy merged commit 932ec10 into main Jun 30, 2021
@steven-sheehy steven-sheehy deleted the github-docs branch June 30, 2021 20:24
ijungmann pushed a commit that referenced this pull request Jul 16, 2021
* Add a issue template config.yml since discussions link is project specific
* Add documentation on use of passwords
* Fix a line rendering error in deployment diagram
* Remove GitHub docs in favor of organization level configuration

Signed-off-by: Steven Sheehy <steven.sheehy@hedera.com>
Signed-off-by: Ian Jungmann <ian.jungmann@hedera.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Type: Improvements or additions to documentation P2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants