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

chore: update flamingo rotation manual #1376

Merged
merged 4 commits into from
Aug 20, 2024

Conversation

morph-dev
Copy link
Collaborator

@morph-dev morph-dev commented Aug 13, 2024

What was wrong?

Some information on the Flamingo manual seems to be outdated, most notably the "notes".

While I don't have access to the notes and checklist, Kolby told me that we weren't really using them for the last couple of months.

How was it fixed?

Remove the references to the notes. If people think they were useful, should we consider restarting doing them? Should we consider alternatives?

I'm not sure what items are on the checklist (no access), but maybe we can put them on the Flamingo page directly? Can anybody share it with me?

To-Do

  • Add checklist items directly into Flamingo page
  • Clean up commit history and use conventional commits.

@morph-dev morph-dev added documentation Improvements or additions to documentation flamingo Maintenance or downtime for the person on Flamingo rotation to tackle labels Aug 13, 2024
@morph-dev morph-dev self-assigned this Aug 13, 2024
@ogenev
Copy link
Member

ogenev commented Aug 13, 2024

Here is the current checklist template but I think we need to simplify and improve it if we plan to use it:

Weekly trin Flamingo Checklist

Monday

Kickoff:

  • Announce that you are on rotation in Discord
  • Give yourself the Discord role @trin-flamingo
  • Read handoff notes from previous rotation
  • Give weekly summary update in all-Portal call
  • Link this checklist into the weekly notes
  • Pick day of week for deployment, discuss in #trin

Daily:

  • Read Discord, especially for help requests or signs of network issues
  • Monitor Glados changes, and corrolate with releases (trin, glados, other clients?)
  • Monitor portal-hive changes
    • Check the dates, did all test suites run on the previous cycle?
    • For each suite, did the expected number of tests run?
    • Did trin start failing any tests? (While other clients are catching up, focus on "trin,trin" tests)
    • If trin failing, create rotation issue to pursue
  • Look for inspiration for Flamingo projects
  • Update week's notes with progress & plans

Tuesday

  • Read Discord, especially for help requests or signs of network issues
  • Monitor Glados changes, and corrolate with releases (trin, glados, other clients?)
  • Monitor portal-hive changes
    • Check the dates, did all test suites run on the previous cycle?
    • For each suite, did the expected number of tests run?
    • Did trin start failing any tests? (While other clients are catching up, focus on "trin,trin" tests)
    • If trin failing, create rotation issue to pursue
  • Look for inspiration for Flamingo projects
  • Update week's notes with progress & plans

Wednesday

  • Read Discord, especially for help requests or signs of network issues
  • Monitor Glados changes, and corrolate with releases (trin, glados, other clients?)
  • Monitor portal-hive changes
    • Check the dates, did all test suites run on the previous cycle?
    • For each suite, did the expected number of tests run?
    • Did trin start failing any tests? (While other clients are catching up, focus on "trin,trin" tests)
    • If trin failing, create rotation issue to pursue
  • Look for inspiration for Flamingo projects
  • Update week's notes with progress & plans

Thursday

  • Unique: Identify the next Flamingo
  • Read Discord, especially for help requests or signs of network issues
  • Monitor Glados changes, and corrolate with releases (trin, glados, other clients?)
  • Monitor portal-hive changes
    • Check the dates, did all test suites run on the previous cycle?
    • For each suite, did the expected number of tests run?
    • Did trin start failing any tests? (While other clients are catching up, focus on "trin,trin" tests)
    • If trin failing, create rotation issue to pursue
  • Look for inspiration for Flamingo projects
  • Update week's notes with progress & plans

Friday

Wrap-up:

  • Haven't deployed yet? Oops, a bit late. Get it done as early as possible.
  • Comment on the checklist template to add/update/delete anything?

Daily:

  • Read Discord, especially for help requests or signs of network issues
  • Monitor Glados changes, and corrolate with releases (trin, glados, other clients?)
  • Monitor portal-hive changes
    • Check the dates, did all test suites run on the previous cycle?
    • For each suite, did the expected number of tests run?
    • Did trin start failing any tests? (While other clients are catching up, focus on "trin,trin" tests)
    • If trin failing, create rotation issue to pursue
  • Look for inspiration for Flamingo projects
  • Update week's notes with progress & plans

Handoff:

  • Add next week to top of Flamingo notes, with next person on rotation
  • Final review of Flamingo notes, summarize for readability
  • Send the Flamingo notes link to the next Flamingo

@morph-dev
Copy link
Collaborator Author

Thanks. I simplified and added checklist.

Another topic that I would like to discuss. Should we restart using Flamingo rotation document?
I think it's really useful to have long term overview, especially when in comes to planning vacations and such

Copy link
Collaborator

@njgheorghita njgheorghita left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🦩

1. Signal to the next Flamingo that you're done writing up the notes
2. Give the next Flamingo a reminder that their turn is coming up
3. A failsafe to make sure we didn't forget to pick a Flamingo for the following week
Think through: what kinds of things do you think should on the checklist?
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do you think should be on the checklist


Especially while we continue to develop the procedure, try to be available the following Monday to help the subsequent Flamingo transition in, and get started.
Double check the [Flamingo schedule](https://notes.ethereum.org/@njgheorghita/r1angO2lT) and make sure you're available for your next rotation. If not, please switch with somebody asap.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is also another remnant that isn't actively maintained.

  • I can update the schedule
  • Update this to say something like... "estimate when you'll be flamingo next and make sure you're available..."

Copy link
Collaborator Author

@morph-dev morph-dev Aug 14, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As I said in the other comment, I think we should restart using it.

And there shouldn't be "estimation" on when next shift should come, meaning that it should always be planned at least one-two months in the future. With that being said, I would leave it as it is written now.

I volunteer to take responsibility and make sure we always have a schedule ahead. Others just have to be sure they keep it updated when they change shifts.

@ogenev
Copy link
Member

ogenev commented Aug 14, 2024

Another topic that I would like to discuss. Should we restart using Flamingo rotation document?

I don't have access to this document, @njgheorghita if you are the owner, could you add me? :)

@njgheorghita
Copy link
Collaborator

@ogenev @morph-dev Yup, I'm happy to open access to that document... but maybe there's a simpler place to host this message? Like an open issue in this repo or something else more github-y

@morph-dev
Copy link
Collaborator Author

@ogenev @morph-dev Yup, I'm happy to open access to that document... but maybe there's a simpler place to host this message? Like an open issue in this repo or something else more github-y

I already gave access to @ogenev.

I'm fine with a current document. But if preferred, we can easily make a .md file in github (e.g. at root folder).

@KolbyML
Copy link
Member

KolbyML commented Aug 15, 2024

I am not a fan of having a constantly updated flamingo whose turn it is document in the trin repo, if we want a repo with a md document we should make a flamingo repo for it or a discord channel

Copy link
Collaborator

@carver carver left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚢


- **Daily**
- Read Discord, especially for help requests or signs of network issues
- Monitor [Glados](http://glados.ethportal.net/) changes, and correlate with releases (trin, glados, other clients?)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Monitor [Glados](http://glados.ethportal.net/) changes, and correlate with releases (trin, glados, other clients?)
- Monitor [Glados](https://glados.ethdevops.io/) changes, and correlate with releases (trin, glados, other clients?)

I know this url was out of date elsewhere in the docs. Might as well update it while you're tweaking.

@morph-dev
Copy link
Collaborator Author

I'm merging this one. If anybody has additional followup, I will make another PR.

@morph-dev morph-dev merged commit b4a81e3 into ethereum:master Aug 20, 2024
11 checks passed
@morph-dev morph-dev deleted the flamingo_docs branch August 20, 2024 07:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation flamingo Maintenance or downtime for the person on Flamingo rotation to tackle
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants