Migrate important info to Confluence wiki page with watchers #78
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tthyer
approved these changes
Nov 18, 2021
There was a problem hiding this comment.
I approve of moving anything that is Sage-related to Confluence. nextflow-infra could still be used by people outside Sage, so ideally the README would be for that audience.
Regarding trigger builds with README edits, there's a way to skip builds for those edits:
on:
push:
paths-ignore:
- README.md
|
@tthyer: I should have known that there was a way to exclude files from the CI trigger. I added an exclusion for Markdown files. The updates to the important information are intended for Sage staff on how to use our internal Tower instance. The mechanics of our repository can remain documented in README/CONTRIBUTING (at least until we set up a library repository). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In this PR, I propose using a Confluence wiki page to disseminate important information. I was initially going to create a Google Group, but I like how diffs are emailed to watchers on Confluence. Edits can optionally be published without notifying users in case we need to add less critical information.
An added benefit of this approach is that we don't have to trigger our CI workflow with frequent edits to the README.
Here's the Confluence page: https://sagebionetworks.jira.com/l/c/1hm4NP7a. Only Tess, Tom, and I have edit-access at the moment. Let me know if there's any important information that should be added.