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

Add README files for updater/ and updog #381

Merged
merged 2 commits into from
Oct 16, 2019
Merged

Add README files for updater/ and updog #381

merged 2 commits into from
Oct 16, 2019

Conversation

sam-aws
Copy link
Contributor

@sam-aws sam-aws commented Oct 8, 2019

Issue #, if available:
#189

Description of changes:
Add a top-level README.md for updater/ and expand the README.md for Updog. The first of these aims to give an overview of the Thar update infrastructure.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@sam-aws sam-aws requested a review from iliana October 8, 2019 21:22
Copy link
Contributor

@tjkirch tjkirch left a comment

Choose a reason for hiding this comment

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

This is great, I love it, thank you so much! Happy to have this now, regardless of my comments below, because it's great documentation and obviously better than what we have now.

One overall suggestion I didn't want to litter in comments: in Markdown, it's nice to put each sentence on its own line. (They don't get put into new paragraphs unless you have two newlines, i.e. a blank line, so one is safe.) That way, in reviews like this, it's easier to see differences and make suggestions because you deal with sentences instead of whole paragraphs. And it doesn't affect the rendering at all!

workspaces/updater/updog/README.md Show resolved Hide resolved
workspaces/updater/updog/src/main.rs Outdated Show resolved Hide resolved
workspaces/updater/updog/README.md Outdated Show resolved Hide resolved
workspaces/updater/update-system.drawio Outdated Show resolved Hide resolved
workspaces/updater/update-system.drawio Outdated Show resolved Hide resolved
workspaces/updater/README.md Outdated Show resolved Hide resolved
workspaces/updater/README.md Outdated Show resolved Hide resolved
workspaces/updater/README.md Outdated Show resolved Hide resolved
workspaces/updater/README.md Show resolved Hide resolved
workspaces/updater/README.md Outdated Show resolved Hide resolved
@sam-aws
Copy link
Contributor Author

sam-aws commented Oct 11, 2019

Updated both READMEs and the usage formatting - haven't got into the diagram suggestions yet.

@sam-aws
Copy link
Contributor Author

sam-aws commented Oct 15, 2019

Updates to diagram and usage examples.

Signed-off-by: Samuel Mendoza-Jonas <[email protected]>
Signed-off-by: Samuel Mendoza-Jonas <[email protected]>
@sam-aws sam-aws merged commit 8192327 into develop Oct 16, 2019
@sam-aws sam-aws deleted the updater-docs branch October 16, 2019 20:08
@tjkirch tjkirch mentioned this pull request Oct 16, 2019
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants