Skip to content

Conversation

@grokspawn
Copy link
Contributor

Description of the change:
Attempt to make verbiage less complex by:

  • removing commentary
  • eliminating passive voice
  • adding emphasis to distinguish between new and already-present CSV cases during graph rebuild
  • eliminated paragraph references
  • add whitespace to delimit complete thoughts and focus the eye on the fact that they were discrete

Motivation for the change:
As a first-touch user reading the docs, I found it difficult to follow the graph update section and thought it could be simplified while retaining intent

Reviewer Checklist

  • Implementation matches the proposed design, or proposal is updated to match implementation
  • Sufficient unit test coverage
  • Sufficient end-to-end test coverage
  • Docs updated or added to /docs
  • Commit messages sensible and descriptive

@openshift-ci openshift-ci bot requested review from ankitathomas and awgreene April 22, 2022 20:56
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Apr 22, 2022

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: grokspawn
To complete the pull request process, please assign dinhxuanvu after the PR has been reviewed.
You can assign the PR to them by writing /assign @dinhxuanvu in a comment when ready.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@codecov
Copy link

codecov bot commented Apr 22, 2022

Codecov Report

Merging #946 (36df550) into master (aabc493) will increase coverage by 0.97%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #946      +/-   ##
==========================================
+ Coverage   52.35%   53.32%   +0.97%     
==========================================
  Files         103      103              
  Lines        9136     9449     +313     
==========================================
+ Hits         4783     5039     +256     
- Misses       3448     3476      +28     
- Partials      905      934      +29     
Impacted Files Coverage Δ
alpha/declcfg/diff_include.go 70.21% <0.00%> (+2.28%) ⬆️
alpha/action/diff.go 79.64% <0.00%> (+2.59%) ⬆️
alpha/declcfg/diff.go 84.25% <0.00%> (+3.52%) ⬆️

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 aabc493...36df550. Read the comment docs.

@grokspawn grokspawn force-pushed the grokspawn-smooth-under-the-hood-graph-gen-docs branch from 68544b7 to d14baee Compare May 18, 2022 17:43
fixing old html tags to correct indent, flow

Signed-off-by: Jordan Keister <jordan@nimblewidget.com>
@grokspawn grokspawn force-pushed the grokspawn-smooth-under-the-hood-graph-gen-docs branch from d14baee to 36df550 Compare May 19, 2022 17:49
@timflannagan
Copy link
Member

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label May 19, 2022
@grokspawn grokspawn merged commit 1436816 into master May 24, 2022
@grokspawn grokspawn deleted the grokspawn-smooth-under-the-hood-graph-gen-docs branch May 24, 2022 16:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

lgtm Indicates that a PR is ready to be merged.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants