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.

Sign up for GitHub

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

Jump to bottom

README cleanup and simplification #3104

Merged
merged 4 commits into from
Jan 7, 2022
Merged

README cleanup and simplification #3104

merged 4 commits into from
Jan 7, 2022

Conversation

steven-sheehy
Copy link
Member

@steven-sheehy steven-sheehy commented Jan 5, 2022 •
edited
Loading

Description:

  • Change docker-compose commands to docker compose built into Docker
  • Change to de-emphasize Docker Compose in favor of Helm/Kubernetes
  • General grammar and spelling cleanup
  • Move component documentation to docs/<component>/README.md
  • Move Docker Compose details from README.md to docs/installation.md
  • Remove references to "Beta" mirror node
  • Remove irrelevant TimescaleDB docs
  • Remove unused REST API performance images
  • Simplified mirror node overview

Related issue(s):

Notes for reviewer:

Checklist

  • Documented (Code comments, README, etc.)
  • Tested (unit, integration, etc.)

@steven-sheehy
Simplify README and push details into sub-documents
b86e352 
Signed-off-by: Steven Sheehy <steven.sheehy@hedera.com>
@steven-sheehy steven-sheehy added documentation Type: Improvements or additions to documentation P3 labels Jan 5, 2022
@steven-sheehy steven-sheehy added this to the 0.49.0 milestone Jan 5, 2022
@steven-sheehy steven-sheehy requested a review from a team January 5, 2022 23:12
@steven-sheehy steven-sheehy self-assigned this Jan 5, 2022
@codecov
Copy link

codecov bot commented Jan 5, 2022 •
edited
Loading

Codecov Report

Merging #3104 (169c1a1) into main (4e3bbef) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##               main    #3104   +/-   ##
=========================================
  Coverage     88.23%   88.23%           
  Complexity     2393     2393           
=========================================
  Files           483      483           
  Lines         13494    13494           
  Branches       1227     1227           
=========================================
  Hits          11906    11906           
  Misses         1276     1276           
  Partials        312      312

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 4e3bbef...169c1a1. Read the comment docs.

@steven-sheehy steven-sheehy changed the title Simplify README and push details into sub-documents README cleanup and simplification Jan 5, 2022
@steven-sheehy
Minor tweaks
e9f7662 
Signed-off-by: Steven Sheehy <steven.sheehy@hedera.com>
xin-hedera
xin-hedera requested changes Jan 7, 2022
View reviewed changes
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/installation.md Outdated Show resolved Hide resolved
docs/installation.md Outdated Show resolved Hide resolved
docs/installation.md Outdated Show resolved Hide resolved
@steven-sheehy
Address review feedback
eaece2f 
Signed-off-by: Steven Sheehy <steven.sheehy@hedera.com>
xin-hedera
xin-hedera previously approved these changes Jan 7, 2022
View reviewed changes
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

ijungmann
ijungmann previously approved these changes Jan 7, 2022
View reviewed changes
Copy link
Contributor

@ijungmann ijungmann left a comment

Choose a reason for hiding this comment

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

Looks good, some nits and suggestions if you'd like input, but nothing major.

docs/installation.md Outdated Show resolved Hide resolved
docs/installation.md Outdated Show resolved Hide resolved
docs/installation.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/operations.md Outdated Show resolved Hide resolved
@steven-sheehy
Address review feedback
169c1a1 
Signed-off-by: Steven Sheehy <steven.sheehy@hedera.com>
@sonarcloud
Copy link

sonarcloud bot commented Jan 7, 2022

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@steven-sheehy steven-sheehy merged commit fbad635 into main Jan 7, 2022
@steven-sheehy steven-sheehy deleted the docs-cleanup branch January 7, 2022 22:23
@steven-sheehy steven-sheehy mentioned this pull request Jan 10, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ijungmann ijungmann ijungmann approved these changes

@atul-hedera atul-hedera Awaiting requested review from atul-hedera

@xin-hedera xin-hedera Awaiting requested review from xin-hedera

Assignees

@steven-sheehy steven-sheehy

Labels
documentation Type: Improvements or additions to documentation P3
Projects
None yet
Milestone
0.49.0
Development

Successfully merging this pull request may close these issues.
3 participants
@steven-sheehy @ijungmann @xin-hedera