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

Update custom CCI flows to improve documentation #147

Open
samanthashain opened this issue Jul 14, 2022 · 2 comments
Open

Update custom CCI flows to improve documentation #147

samanthashain opened this issue Jul 14, 2022 · 2 comments
Labels
enhancement New feature or request help wanted Extra attention is needed question Further information is requested

Comments

@samanthashain
Copy link
Contributor

What are you trying to accomplish?

What do you think might be involved in the solution?

  • Determine reasonable naming convention
  • update custom cci flows in cumulusci.yml file
  • audit docs and update references to custom cci flows if necessary
@samanthashain samanthashain added enhancement New feature or request help wanted Extra attention is needed question Further information is requested labels Jul 14, 2022
@programmer2coder
Copy link
Contributor

During today's working meeting, we (me and @jenncarneiro ) identified 3 flows contained in the Snowfakery Recipe Templates cumulusci.yml file. https://github.com/SFDO-Community-Sprints/Snowfakery-Recipe-Templates/blob/main/cumulusci.yml . Pretty sure these are the

  1. **osc_memberships_project**. description: OSC Membership Schema and Benefits project
    
  2. **npsp_org**.  (no description)
    
  3. **npsp_scratch**. description: Requires default org to be set. Installs npsp and creates a bunch of default settings to make the data look more realistic
    
  • What would be a reasonable naming convention?
  • Should we invent a prefix for our project and rename them with that?
  • Will it actually help to rename them, or is this more of a "help contributors understand that custom cci flows only work in this repo".

Hey @prescod and/or @acrosman can you provide us some direction here?

@programmer2coder
Copy link
Contributor

In a Zoom discussion with @prescod he agreed that an appropriate resolution to this issue would be to provide documentation to "help contributors understand that custom cci flows only work in this repo". And that no re-naming of the flows in the projects's cumulusci.yml file would be necessary.

@allisonletts allisonletts changed the title Update custom CCI flows with improved Naming Convention Update custom CCI flows to improve documentation Nov 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants