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

Watcher docs updates & deduplication #286

Closed
zramsay opened this issue Jan 3, 2023 · 1 comment
Closed

Watcher docs updates & deduplication #286

zramsay opened this issue Jan 3, 2023 · 1 comment
Assignees
@zramsay

Comments

@zramsay
Copy link
Contributor

zramsay commented Jan 3, 2023

Some watchers are now documented in 3 places: as a stack in SO, in their readme.md, and in their demo.md.
As well, across most watchers' readme/demo in this repo, there is a lot of duplication; eg. how to setup the stack, which is now somewhat redundant with SO.

My solution is to pull out all the duplicate information into a single document for devs to run the stack without SO. Then to merge any demo.md into the README.md, and where applicable point to the SO stack demo. The idea being that SO gets the ball rolling for folks then they come back here to get more into the weeds.
@zramsay zramsay self-assigned this Jan 3, 2023
@AFDudley
Copy link
Contributor

AFDudley commented Jan 3, 2023

Sounds like a plan. Thanks.

@zramsay zramsay mentioned this issue Jan 9, 2023
Merged
8 tasks
@zramsay zramsay closed this as completed Jan 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@zramsay zramsay

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@AFDudley @zramsay