-
Notifications
You must be signed in to change notification settings - Fork 55
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
Issue-130: Align OH / IEAM docs #220
Conversation
Signed-off-by: John Walicki <[email protected]>
Signed-off-by: John Walicki <[email protected]>
Signed-off-by: John Walicki <[email protected]>
Signed-off-by: John Walicki <[email protected]>
Signed-off-by: John Walicki <[email protected]>
Signed-off-by: John Walicki <[email protected]>
Signed-off-by: John Walicki <[email protected]>
Signed-off-by: John Walicki <[email protected]>
Signed-off-by: John Walicki <[email protected]>
Signed-off-by: John Walicki <[email protected]>
Signed-off-by: John Walicki <[email protected]>
Signed-off-by: John Walicki <[email protected]>
Signed-off-by: John Walicki <[email protected]>
Signed-off-by: John Walicki <[email protected]>
Signed-off-by: John Walicki <[email protected]>
Signed-off-by: John Walicki <[email protected]>
Signed-off-by: John Walicki <[email protected]>
Signed-off-by: John Walicki <[email protected]>
Signed-off-by: John Walicki <[email protected]>
Signed-off-by: John Walicki <[email protected]>
Signed-off-by: John Walicki <[email protected]>
Signed-off-by: John Walicki <[email protected]>
Signed-off-by: John Walicki <[email protected]>
Signed-off-by: John Walicki <[email protected]>
Signed-off-by: John Walicki <[email protected]>
Signed-off-by: John Walicki <[email protected]>
Signed-off-by: John Walicki <[email protected]>
Signed-off-by: John Walicki <[email protected]>
Signed-off-by: John Walicki <[email protected]>
Signed-off-by: John Walicki <[email protected]>
Signed-off-by: John Walicki <[email protected]>
Signed-off-by: John Walicki <[email protected]>
Signed-off-by: John Walicki <[email protected]>
Signed-off-by: John Walicki <[email protected]>
Signed-off-by: John Walicki <[email protected]>
Signed-off-by: John Walicki <[email protected]>
Signed-off-by: John Walicki <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See all my inline comments. Some may be out of scope for this effort and thus may need to be converted into separate issues. Others require the input of a SME like Booz or Potter.
Signed-off-by: John Walicki <[email protected]>
Signed-off-by: John Walicki <[email protected]>
Signed-off-by: John Walicki <[email protected]>
Too many commits for a single PR 😅 @johnwalicki can you please stash these commits into a single commit? |
I'm a strong believer in small, bite size commits which fix one thing. Each commit in this PR is one file worth of merges between the OH/IEAM documentation. There are 55+ files changed, so, close to 60 commits. A jumbo PR would be indigestible. |
got it :) |
It looks like we only have three comments left to resolve |
Signed-off-by: John Walicki <[email protected]>
Signed-off-by: John Walicki <[email protected]>
@joewxboy - Thanks for the comments/suggestions. I've done some minor fix ups and punted others to track in separate issues. Not perfect but definitely highlights where the docs need more work. I recommend we merge this monster boulder and chip away at the smaller rocks. |
Some recommended changes have been incorporated. Some have been punted to new issues for further discussion / effort.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like all the comments are resolved.
Description
This PR attempts to synchronize as much of the Open Horizon / IEAM production documentation as possible.
Merges were done in both directions. Last Updated fields were synced.
Each modified markdown file is in a separate commit. That way we can discuss, reject, modify any changes I've proposed, individually. I won't have to drag along all the other modifications.
This will also prevent a massive merge conflict when the PR is accepted. (Smaller merge conflicts may occur and will be easier to resolve)
Fixes #130
Type of change
How Has This Been Tested?
I wrote a
edge-doc-compare.sh
bash script which scanned across both cloned repos.Compared the .md files and, if there were differences, loaded them into meld (a file merge/compare tool available on Linux)
I inspected the files and synchronized as much as possible.
Checklist: