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

[WORKFLOWS-15/34] Create README with onboarding docs #46

Merged
merged 22 commits into from
Sep 22, 2021

Conversation

BrunoGrandePhD
Copy link
Contributor

@BrunoGrandePhD BrunoGrandePhD commented Aug 20, 2021

Here's a first draft. Does anyone have feedback? Are there any other sections that I should add?

The formatted README can be read here.

@BrunoGrandePhD BrunoGrandePhD requested a review from a team as a code owner August 20, 2021 00:05
@thomasyu888
Copy link
Collaborator

Thanks! My first look at this is it looks good!

  • Is there a requirement that things must go into develop first prior to prod?
  • Is nf-tower only built on prod?

README.md Outdated Show resolved Hide resolved
@BrunoGrandePhD
Copy link
Contributor Author

  • Is there a requirement that things must go into develop first prior to prod?

@thomasyu888: I hadn't thought that far ahead yet since we're still setting things up. That said, we could make it a requirement in CONTRIBUTING.md. Once NF Tower is up and running in prod, we probably want to be conservative with changes to ensure it doesn't go down, similar to the Service Catalog model.

@tthyer: What do you think?

  • Is nf-tower only built on prod?

@thomasyu888: I expect there to be an instance of NF Tower also running in develop for the reason detailed above.

@BrunoGrandePhD BrunoGrandePhD mentioned this pull request Aug 24, 2021
@tthyer
Copy link
Contributor

tthyer commented Aug 25, 2021

@BrunoGrandePhD @thomasyu888 Regarding things going into dev before prod, the way I have been thinking of this is that if you're developing a new template, it should go into dev first, and generally we may even want sample deployments in dev, such as sample-nextflow-s3-bucket. If you're just creating a new sceptre configuration, it can go straight into prod, such as bgrande-nextflow-s3-bucket.

The license allows us to have a development and production version of the tower. I would like to see the development deployment really used for development / changes, so we have a place where we're not disturbing users to make changes and updates. PHI or not, use of tower to run workflows can happen in the production account.

@BrunoGrandePhD BrunoGrandePhD changed the title [WORKFLOWS-15] Create README for repository [WORKFLOWS-15; WORKFLOWS-34] Create README with onboarding documentation Sep 1, 2021
@BrunoGrandePhD BrunoGrandePhD changed the title [WORKFLOWS-15; WORKFLOWS-34] Create README with onboarding documentation [WORKFLOWS-15/34] Create README with onboarding documentation Sep 1, 2021
@BrunoGrandePhD BrunoGrandePhD changed the title [WORKFLOWS-15/34] Create README with onboarding documentation [WORKFLOWS-15/34] Create README with onboarding docs Sep 1, 2021
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@BrunoGrandePhD
Copy link
Contributor Author

I'm going to work on this once we merge other PRs that change the onboarding experience.

Depends on #62 (and a future PR where we switch from hook to CI step)

@BrunoGrandePhD BrunoGrandePhD marked this pull request as draft September 10, 2021 03:20
@BrunoGrandePhD BrunoGrandePhD marked this pull request as ready for review September 22, 2021 15:24
@BrunoGrandePhD BrunoGrandePhD merged commit 91801fd into main Sep 22, 2021
@BrunoGrandePhD BrunoGrandePhD deleted the bgrande/workflows-15/update-readme branch September 22, 2021 20:27
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.

4 participants