-
Notifications
You must be signed in to change notification settings - Fork 21
November 2023 Working Session
Eileen K edited this page Nov 17, 2023
·
1 revision
- Notes from Data Generation Team workday 2023-11-17
- Participants: Eileen K, Jenn C, Paul P
- We discussed the team’s intent to overhaul our project documentation. We agreed:
- Documentation intended for users of Snowfakery recipes, from beginner on up, shall be written in Markdown (MD) format, stored in the Github repo, and made publicly available as Github Pages. This is consistent with the direction of other projects in the Commons.
- Documentation intended for the project team and other project contributors, shall remain in the Wiki.
- Any topics that pertain to both of the above, shall be detailed in the Github Pages; where appropriate, the Wiki can refer by linking to the relevant Page.
- As part of the overhaul, we still need to identify and edit places in the docs of DataGen repo that unintentionally reference Snowfakery project, and vice versa (leftover from when one repo got split in two).
- Eileen will create a list of Wiki and MD doc pages across the 2 repo’s, their title & location, in order to organize the ongoing overhaul. The list will also have columns to track Audience and Reviewed Status. And make that list shared online available to the project team (ideally before the next project team meeting).
- Paul has started to make the existing MD files viewable online as Pages, see Snowfakery-Recipe-Templates Pages .
- Several discussion topics today led us back to the question of identifying our audience. Who are we writing this documentation for?
- People who use our tools, whose main role is as a Salesforce admin
- People who use our tools, who may be consultants or developers
- Project team members and contributors
- The team needs to get more use cases and user stories for these audiences (especially admins!)
- The repo has a document of a persona "Meet Alex" which is a good starting point yet could use an update.
- The team has an issues list in DataGen repo & one in Snowfakery Recipes repo
- In discussing a couple of issues (112, 140), they were not about recipes in our repo, but pertained to the code in the project’s Cumulusci.yml file. We created a new issue Label for this “cumulusci.yml”.
- We discussed best practices and team preferences in using a Github Issues List. Jenn is collecting information and started writing a Guide, which will include:
- How do you prioritize an issue list?
- How do you get to the KanBan view?
- How do you assign or update a Status for an issue?
- What’s the difference between a Status and a Label?
- For a bug issue, what does it mean to move this issue forward?
- Do you have to de-assign someone before assigning a new person? (no)
- We closed a couple of issues today that had an associate PR that got merged, but that somehow had not closed it’s related issue.
- We moved a couple of issues forward by adding comments/questions, and tagged somebody that might likely know the answer.
- Eileen will update internal descriptions for Flows in the project’s Cumulusci.yml file, based on intel from Paul. Also, to write documentation to help clarify that Flows there (“custom flows”) are only available to run from within the repo or when explicitly referenced from another repo.
- [Did you know we already have 2 Projects in our repo! But I had to go to “classic” to see them https://github.com/SFDO-Community-Sprints/Snowfakery-Recipe-Templates/projects?type=classic ]
- Jenn was able to create a scratch org for Nonprofit Cloud (NPC) based on Aaron’s repo, but Eileen encountered problems. (We set this aside for today, as no NPC recipe requests are yet on the issues list.)
- Today I learned: “If you’re currently using sfdx (v7), we highly recommend that you move to sf (v2).” Ref here. [Yes. Just a few months after learning SFDX, I learn it is going away.]