Bi-weekly summary of handbook changes

@team

Summary of merge requests for opencraft/documentation/public from 2023-07-11

Merge request: build: Update pip-tools version.
Description: This PR updates the version of pip-tools used, since pip has shifted underneath it in an incompatible way.

Testing instructions:

  1. Verify the build worked this time.

Author: Fox Piacenti

For more details visit: #516.


Merge request: refactor: Move Yusuf from Bebop to Falcon.
Description: What it says on the tin.

Tickets

Author notes

  • Timing of move (= Sprint 303) was confirmed here.

Author: Tim Krones

For more details visit: #515.


Merge request: chore: Removed Giovanni and updated Christofer as Sprint Manager
Description:

Author: Christofer Chávez Carazas

For more details visit: #514.


@team

Summary of merge requests for opencraft/documentation/public from 2023-07-25

Merge request: chore: Add Steven and update Christofer as Sprint Planning Manager backup
Description:

Author: Christofer Chávez Carazas

For more details visit: #519.


Merge request: feat: adds mohamed akram to bebop
Description:

Author: Arunmozhi

For more details visit: #518.


@team

Summary of merge requests for opencraft/documentation/public from 2023-08-08

Merge request: refactor: Move Pooja from Bebop to Falcon
Description: … and remove cell-specific vacation rule for Falcon.

With Pooja joining Falcon, the cell is back to five members and therefore large enough to no longer need a larger holiday buffer.

Tickets

Author: Tim Krones

For more details visit: #523.


Merge request: [BB-7516] Improve mentoring documentation
Description: Updates to the mentoring related documentation so that mentors can better support recruits in the new trial-project based process.

Author: Arunmozhi

For more details visit: #522.


@team

Summary of merge requests for opencraft/documentation/public from 2023-08-22

Merge request: chore: Update Romulo to core
Description:

Author: Christofer Chávez Carazas

For more details visit: #526.


Merge request: chore: add missing configs to ReadTheDocs
Description: Add missing readthedocs configs to prepare for upcoming migration

Author: Kaustav Banerjee

For more details visit: #525.


Merge request: chore: remove steven
Description:

Author: Christofer Chávez Carazas

For more details visit: #524.


Merge request: [STAR-3252] Improving admin-related doc
Description: This MR introduces a few improvements in the documentation, mostly on items about invoicing and admin processes. Most of it comes from frequent questions we get from newcomers.

Author: Gabriel D’Amours

For more details visit: #521.


Merge request: feat: Add “How to handle code drift” section
Description: New section that explains what processes exist to help handling and
minimizing code drift across our forks.

Author: Yusuf Musleh

For more details visit: #520.


1 Like

@team

Summary of merge requests for opencraft/documentation/public from 2023-09-05

Merge request: refactor: Make Navin backup for Sprint Manager role after moving Pooja from Bebop to Falcon.
Description: Follows up on !523.

Screenshots

Tickets

Author: Tim Krones

For more details visit: #530.


Merge request: fix: Fix broken links in glossary
Description: This MR addresses the broken links in the glossary. Fixes Outdated Hyperlinks in the Handbook (#69) · Issues · opencraft / documentation / public · GitLab

Author: Yusuf Musleh

For more details visit: #528.


Merge request: chore: Update Yusuf to core
Description:

Author: Christofer Chávez Carazas

For more details visit: #527.


@team

Summary of merge requests for opencraft/documentation/public from 2023-09-19

Merge request: chore: Add moncef
Description:

Author: Christofer Chávez Carazas

For more details visit: #533.


Merge request: feat: remove akram from bebop and add artur
Description:

Author: Arunmozhi

For more details visit: #532.


Merge request: refactor: replace zoom jwt auth with oauth
Description: This PR removes Zoom JWT auth app usage with Zoom Oauth app as JWT has been deprecated by them and it will be removed soon.

Successful pipeline run.

PS: I have already updated the CI/CD env variables with the new secrets.

Update:

The scheduled pipeline also ran successfully and migrated retrospective meeting, ref.

Author: Navin Karkera

For more details visit: #531.


Merge request: docs: Add private link annotations + include info
Description: This adds annotations on private links mentioning that they are meant
for OpenCraft employees in the footnotes. For private links that contain
information that could be useful for the public that information has
been extracted and included in the docs.

Fixes Remove/annotate links to private content in public handbook (#71) · Issues · opencraft / documentation / public · GitLab

Author: Yusuf Musleh

For more details visit: #529.


@team

Summary of merge requests for opencraft/documentation/public from 2023-10-03

Merge request: feat: adds rafay to bebop
Description:

Author: Arunmozhi

For more details visit: #535.


Merge request: docs: Multiple improves and changes to keep sync with the onboarding course
Description: This updates the handbook with:

  • Fixing multiple broken list.
  • Changes to keep sync with the onboarding course.

Related task: BB-7817

Testing instructions

  • Run this docs in your local computer.
  • Check the changes.

Author: Christofer Chávez Carazas

For more details visit: #534.


@team

Summary of merge requests for opencraft/documentation/public from 2023-10-17

Merge request: chore: Add Sid to handbook
Description:

Author: Christofer Chávez Carazas

For more details visit: #537.


Merge request: docs: Revise client briefing maintenance process.
Description: This MR changes the client briefing update process and moves explanation of the client strategy tickets into a dedicated section within the ‘Working with Clients’ page.

JIRA tickets: Log in - OpenCraft

Discussions: Ensuring the up-to-date maintenance of Client Briefings

Testing instructions:

  1. Check the ‘view app’ link on this MR to see the changes previewed.
  2. Verify the formatting looks correct.

Author: Fox Piacenti

For more details visit: #513.


@team

Summary of merge requests for opencraft/documentation/public from 2023-10-31

Merge request: feat: add Stephannie to Bebop cell memberlist
Description:

Author: Arunmozhi

For more details visit: #538.


Merge request: [STAR-3263]: Better overview of Epic Owner scope and duties.
Description: This MR adds in a better overview of what an Epic owner actually is and does, and what understanding a team member should have about their relationship to a project where they are the epic owner.

JIRA tickets: Log in - OpenCraft

Author: Fox Piacenti

For more details visit: #536.


@team

Summary of merge requests for opencraft/documentation/public from 2023-11-14

Merge request: chore: update listaflow template link
Description: Updates listaflow url in manual instance checklist page

Author: Kaustav Banerjee

For more details visit: #539.


@team

Summary of merge requests for opencraft/documentation/public from 2023-11-28

Merge request: Romulo will be Falcon’s Sprint Planning Manager
Description: Changes Falcon’s Sprint Planning Manager from Jill to Romulo, whose time zone is better suited to the updated sprint planning schedule detailed in feat: shift sprint planning by day earlier (!543) · Merge requests · opencraft / documentation / public · GitLab

Testing instructions

  1. Check the preview Cells > Falcon > Roles is correct.

Ticket to log time: FAL-62

Author: Jillian Vogel

For more details visit: #544.


Merge request: feat: shift sprint planning by day earlier
Description: ### Description

This MR updates handbook to reflect the changes in the sprint process:

  • Deadline for creating tickets for the next sprint is shifted from Thursday W2 to Wednesday W2
  • Async estimation sessions will close at 00:00 UTC Friday W2 instead of 00:00 UTC Monday W3
  • Tickets estimation and sprint planning will take place on Friday, instead of Monday

References

BB-8256

Author: Maxim Beder

For more details visit: #543.


Merge request: [STAR-3338, STAR-3384] Clean up section on Support vs. Maintenance
Description:

  • Remove links to outdated Price List.
  • Refine information about work that qualifies as hourly support.

See this conversation for relevant context.

Tickets

Testing

Reviewers

  • @FoxyFoxie

Author: Tim Krones

For more details visit: #541.


@team

Summary of merge requests for opencraft/documentation/public from 2023-12-12

Merge request: Minor - Fix formatting issue on firefighting page
Description: Fixes #74

Author: Xavier Antoviaque

For more details visit: #552.


Merge request: Fixes typo in navigation link
Description: See Firefighting v2: Firefighting managers, cell-wide escalation, rotations (!540) · Merge requests · opencraft / documentation / public · GitLab

Author: Xavier Antoviaque

For more details visit: #550.


Merge request: feat: adds daniel to the team bebop
Description:

Author: Arunmozhi

For more details visit: #549.


Merge request: feat: update wording for GitHub fork access instructions
Description:

Author: Artur Gaspar

For more details visit: #546.


Merge request: docs: make ticket estimation steps more explicit
Description: ### Description

This MR is a follow up to feat: shift sprint planning by day earlier (!543) · Merge requests · opencraft / documentation / public · GitLab. The purpose of this MR is mainly to make wording more explicit.

References

BB-8256

Author: Maxim Beder

For more details visit: #545.


Merge request: [STAR-3382] Adjust info about social chats.
Description: - Remove outdated info about manual ticket creation. Follows up on this comment (last paragraph).

  • Add info about cell-specific recurring tickets for logging time.
  • Apply a few small tweaks to wording and formatting.

Rendered changes.

Tickets

Author: Tim Krones

For more details visit: #542.


Merge request: Firefighting v2: Firefighting managers, cell-wide escalation, rotations
Description: Implements the outcome of the discussion from Firefighting issues - Coverage, escalation & backups

The diff reflects a significant reorganization and clarification of the firefighting processes and guidelines in the repository’s documentation. Here’s a summarized overview of the overall changes to the processes:

  1. Refactored firefighting sections: The firefighting documentation has been restructured for better clarity. The information about responsibility and processes that was previously split between the roles and the firefighting page have been regrouped in the later. The section about triage guidelines for fires has been split into its own subpage in the firefighting section.

  2. Introduction of firefighting managers roles and additional levels of escalation: Added and described in the firefighting section

  3. Reworked the cell-specific rules for firefighting: In particular, the volume of firefighting hours for Bebop is lowered, the rotations redefined, and the specificities of Falcon explained (exceptions to the firefighting roster, firefighting managers)

Author: Xavier Antoviaque

For more details visit: #540.


1 Like

@team

Summary of merge requests for opencraft/documentation/public from 2023-12-19

Merge request: Minor - Fix formatting issue on firefighting page
Description: Fixes #74

Author: Xavier Antoviaque

For more details visit: #552.


Merge request: Fixes typo in navigation link
Description: See Firefighting v2: Firefighting managers, cell-wide escalation, rotations (!540) · Merge requests · opencraft / documentation / public · GitLab

Author: Xavier Antoviaque

For more details visit: #550.


Merge request: feat: adds daniel to the team bebop
Description:

Author: Arunmozhi

For more details visit: #549.


Merge request: feat: update wording for GitHub fork access instructions
Description:

Author: Artur Gaspar

For more details visit: #546.


Merge request: docs: make ticket estimation steps more explicit
Description: ### Description

This MR is a follow up to feat: shift sprint planning by day earlier (!543) · Merge requests · opencraft / documentation / public · GitLab. The purpose of this MR is mainly to make wording more explicit.

References

BB-8256

Author: Maxim Beder

For more details visit: #545.


Merge request: [STAR-3382] Adjust info about social chats.
Description: - Remove outdated info about manual ticket creation. Follows up on this comment (last paragraph).

  • Add info about cell-specific recurring tickets for logging time.
  • Apply a few small tweaks to wording and formatting.

Rendered changes.

Tickets

Author: Tim Krones

For more details visit: #542.


Merge request: Firefighting v2: Firefighting managers, cell-wide escalation, rotations
Description: Implements the outcome of the discussion from Firefighting issues - Coverage, escalation & backups

The diff reflects a significant reorganization and clarification of the firefighting processes and guidelines in the repository’s documentation. Here’s a summarized overview of the overall changes to the processes:

  1. Refactored firefighting sections: The firefighting documentation has been restructured for better clarity. The information about responsibility and processes that was previously split between the roles and the firefighting page have been regrouped in the later. The section about triage guidelines for fires has been split into its own subpage in the firefighting section.

  2. Introduction of firefighting managers roles and additional levels of escalation: Added and described in the firefighting section

  3. Reworked the cell-specific rules for firefighting: In particular, the volume of firefighting hours for Bebop is lowered, the rotations redefined, and the specificities of Falcon explained (exceptions to the firefighting roster, firefighting managers)

Author: Xavier Antoviaque

For more details visit: #540.


@team

Summary of merge requests for opencraft/documentation/public from 2023-12-26

Merge request: chore: Update tags for larger cells.
Description: This MR adds a tag to both Falcon and Bebop in order to indicate to Listaflow that these cells use extended planning tasks that cells like Serenity and Deathstar do not use due to their smaller size.

JIRA tickets: Log in - OpenCraft

Discussions: Log in - OpenCraft

Author notes and concerns:

  1. Is there a better name for this tag?

Author: Fox Piacenti

For more details visit: #548.


@team

Summary of merge requests for opencraft/documentation/public from 2024-01-02

Merge request: [BB-8270] Recruitment, newcomer and mentoring improvements
Description: The MR improves the handbook guidelines and documentation related to recruitment process, newcomer, and mentor roles.

  • remove any references to the screening review and trial period review
  • emphasize newcomer responsibilities
  • emphasize and clarify mentoring responsibilities
  • explicitly layout the evaluation criteria in the context of a trial project
  • add a template for submitting developer and trial project reviews

Author: Arunmozhi

For more details visit: #551.


Merge request: chore: Update tags for larger cells.
Description: This MR adds a tag to both Falcon and Bebop in order to indicate to Listaflow that these cells use extended planning tasks that cells like Serenity and Deathstar do not use due to their smaller size.

JIRA tickets: Log in - OpenCraft

Discussions: Log in - OpenCraft

Author notes and concerns:

  1. Is there a better name for this tag?

Author: Fox Piacenti

For more details visit: #548.


Merge request: [BB-8162] Tackling sprints without enough tasks & last resort backlog
Description: Ticket

PR to implement the changes resulting from the discussion at
https://forum.opencraft.com/t/tackling-sprints-without-enough-tasks/1615

Introduces a new process for managing sprints with insufficient tasks,
including a “Last resort” backlog and additional responsibilities for
Sprint and Epic Planning Managers to ensure proper task estimation and
workload balance.

  1. Changes in processes/sprints.md:

  2. Changes in roles/list.md:

    • Several updates were made to the role of the Sprint Planning
      Manager:
      • Ensuring all tasks have been estimated at the sprint estimation
        cut-off point.
      • Checking if the work scheduled matches the cell’s capacity.
      • Addressing undercommitment in sprint preparation.
      • Overseeing backlog grooming to ensure it is properly maintained.
    • For Epic Planning Managers, new responsibilities include:
      • Managing the planned workload on epics to match cell capacity.
      • Actions to take if the workload is above or below cell capacity,
        such as informing the recruitment manager, creating tasks for
        epic owners, communicating with the business development specialist, and
        discussing the issue on the forum.
    • Rendered: https://opencraft.gitlab.io/-/documentation/public/-/jobs/5764561052/artifacts/preview/roles/list.html#sprint-planning-manager

Author: Xavier Antoviaque

For more details visit: #547.


@team

Summary of merge requests for opencraft/documentation/public from 2024-01-09

Merge request: [STAR-3443] Add information about Tempo account creation
Description: This MR adds basic information about Tempo accounts and how to use them.

Testing instructions:

  • Read the text and add/comment as necessary

Author: Gabriel D’Amours

For more details visit: #556.


Merge request: refactor: Move Pooja from Falcon to Bebop
Description: … and add cell-specific vacation rule for Falcon.

With Pooja moving to Bebop, Falcon is back to four members and therefore needs a slightly larger holiday buffer.

Lastly, Rafay left the team so remove him from Bebop.

Tickets

CC @tecoholic @XnpioChV

Author: Tim Krones

For more details visit: #555.


Merge request: docs: move the DevOps summary forum post responsability to FF Managers
Description: I suggest changing the responsibility to post the DevOps Review in the forum after the sprint to the FF Manager.

The FF Manager needs to check the entries at the end of the sprint. It will be easier for him to post the summary at the end of this check than for the FFs.

Author: Rômulo Penido

For more details visit: #554.


Merge request: build: fix the condition for forum summaries
Description: This is related to the forum thread with documentation summaries.

Bash uses the “negative reminder”, so this calculation returns -1 when we compare a date before April 18th. Instead of using the absolute value, we can change the comparison to 0, so the condition is true for both 1 and -1.

Author: Piotr Surowiec

For more details visit: #553.


Merge request: [BB-8270] Recruitment, newcomer and mentoring improvements
Description: The MR improves the handbook guidelines and documentation related to recruitment process, newcomer, and mentor roles.

  • remove any references to the screening review and trial period review
  • emphasize newcomer responsibilities
  • emphasize and clarify mentoring responsibilities
  • explicitly layout the evaluation criteria in the context of a trial project
  • add a template for submitting developer and trial project reviews

Author: Arunmozhi

For more details visit: #551.


Merge request: [BB-8162] Tackling sprints without enough tasks & last resort backlog
Description: Ticket

PR to implement the changes resulting from the discussion at
https://forum.opencraft.com/t/tackling-sprints-without-enough-tasks/1615

Introduces a new process for managing sprints with insufficient tasks,
including a “Last resort” backlog and additional responsibilities for
Sprint and Epic Planning Managers to ensure proper task estimation and
workload balance.

  1. Changes in processes/sprints.md:

  2. Changes in roles/list.md:

    • Several updates were made to the role of the Sprint Planning
      Manager:
      • Ensuring all tasks have been estimated at the sprint estimation
        cut-off point.
      • Checking if the work scheduled matches the cell’s capacity.
      • Addressing undercommitment in sprint preparation.
      • Overseeing backlog grooming to ensure it is properly maintained.
    • For Epic Planning Managers, new responsibilities include:
      • Managing the planned workload on epics to match cell capacity.
      • Actions to take if the workload is above or below cell capacity,
        such as informing the recruitment manager, creating tasks for
        epic owners, communicating with the business development specialist, and
        discussing the issue on the forum.
    • Rendered: https://opencraft.gitlab.io/-/documentation/public/-/jobs/5764561052/artifacts/preview/roles/list.html#sprint-planning-manager

Author: Xavier Antoviaque

For more details visit: #547.


@team

Summary of merge requests for opencraft/documentation/public from 2024-01-23

Merge request: [BB-8352] docs: clarify sprint planning manager backlog refinement task
Description: Clarify the steps to be taken when refining the backlog.

Author: Paulo Viadanna

For more details visit: #559.


Merge request: docs: reassign Bebop’s Sprint Manager role
Description: ### Description

Reassign Bebop’s Sprint Manager role from Maxim Beder to Pooja Kulkarni.

References

BB-8509

Author: Maxim Beder

For more details visit: #558.


Merge request: Team raises - Update how newcomers raises are handled
Description: This rule has been amended in the past, but the handbook hadn’t been updated. Updating as per Raises for 2023

Author: Xavier Antoviaque

For more details visit: #557.


@team

Summary of merge requests for opencraft/documentation/public from 2024-02-06

Merge request: chore: remove Stephannie from team list
Description:

Author: Arunmozhi

For more details visit: #562.


Merge request: fix: remove the “Potential for growth” section from review template
Description:

Author: Arunmozhi

For more details visit: #561.


Merge request: chore: update the link to Serenity’s epic planning document
Description: This MR update the link of the Serenity epic planning doc.

Signed-off-by: Gabor Boros gabor.brs@gmail.com

Author: Boros Gábor

For more details visit: #560.


@team

Summary of merge requests for opencraft/documentation/public from 2024-02-20

Merge request: [STAR-3528] Add updates to SalesForce in sales process notes.
Description: This Merge request adds in a note about the Business Development Specialist’s requirement from Axim to update them on referrals.

JIRA tickets: Log in - OpenCraft

Testing instructions:

  1. Check the built version of the docs, which should be linked on this MR page

Author notes and concerns:

Did I describe our relationship correctly? Or is there another term for the role we have with Axim?

Author: Fox Piacenti

For more details visit: #564.


Merge request: [SE-6115] Serenity: Adjust info about cell-specific rules to match current processes
Description: Also apply the following drive-by changes:

  • Fix inconsistent info about process for creating task estimation sessions.
  • Standardize terminology and links for weekly rotation schedule.

Testing

Tickets

Author: Tim Krones

For more details visit: #563.


@team

Summary of merge requests for opencraft/documentation/public from 2024-03-19

Merge request: STAR-3553 - Updating recruitment process documentation
Description: This MR updates a few items pertaining to the recruitment process.

Review instructions:

  • Review the changes and check for any nits
  • Make sure the changes render correctly

Time can be logged on STAR-3553

Author: Gabriel D’Amours

For more details visit: #565.