Giter Site home page Giter Site logo

rmdocs's Introduction

rmdocs

Release Management documentation

rmdocs's People

Contributors

pascalchevrel avatar

Watchers

Sylvestre Ledru avatar James Cloos avatar  avatar

rmdocs's Issues

Create a page for Nightly backouts and respin process

  • When and why we want to back out a patch on Nightly
  • How to find the patch to back out
  • Who to ping and where
  • How we should communicate about it externally and internally
  • Should we respin or not depending on the next nightly update
  • Blocking automatic updates to mitigate impact

Recover past articles on channel blog

We deleted the old Channel blog however I discovered that we actually had good articles articles there linked from the wiki.

I updated the links in our wiki to point to the Wayback Machine snapshot:

We should probably rewrite/update those and either put them on the current blog or turn them into wiki pages.

Dealing with regressions document

We should have a document explaining how we manage regressions:

  • What RM do
  • What developers have to do
  • Bugzilla process -> regression keyword, status flags, reopening bugs…
  • mozregression
  • uplift request if the regression affects beta/release
  • How to handle regressions when all the work is done on Github including the bug tracker
  • link to respin process if the regression is on nightly and is important

Update Nightly cycle action items for RM

https://wiki.mozilla.org/index.php?title=Release_Management/Nightly&oldid=1136006

This page lists the tasks for RelMan during the Nightly cycle
Beginning of a new cycle

During the cycle:

  • Add that we watch all commits for interesting features
  • Add that interesting changes should be communicated to our alpha-testers via Twitter
  • Interesting features visible to the end user should have the relnote flag set
  • Write Release Notes on the fly
  • Watch reports on Twitter, IRC and other communication channels about major regressions. Ask for backout of a patch if the end-user impact may lead to loosing alpha testers.

End of cycle:

  • Check that there is no visual regression on the WNP caused by template changes on mozilla.org or gecko changes a week before merge day

Create a process card template

We have the summarized section, the full section and we could have a process card that lists common points which answer roughly to some of the who/when/why/how/what questions.

The process and summarized process sections also go into these questions but are mostly focused on the how.

The card would respond to the what, why, when, who questions so they give an overview of the process for people that are not going to do the process but need to understand what the process means organization-wise.

Release_Management.wiki cleanup

Source Page:
https://wiki.mozilla.org/index.php?title=Release_Management&oldid=1177887

TODO

TOC:

  • update logo
  • Remove dead link on logo

CONTRIBUTE SECTION:

TEAM INFO:

  • remove "Release_Management/Quarterly_Goals for the relman team"
    -> last goals listed are 2015

COMMUNICATION CHANNELS:

  • add @firefoxnightly twitter
  • add blog
  • add #release-coordination Slack channel

MEETINGS:

CALENDAR UPDATING

  • check that the steps still work with the new google calendar UX
    -> step are completely different, updated and added a direct sharing link
  • Calendar link shouldn't be the full URL

TEAM RESOURCES

  • remove all aurora mentions in text
  • remove "Aurora Landing Process What we do during the Aurora cycle" and put an Obsolete warning on the top of the linked page
  • remove "Aurora channel Blockers and Regressions"
  • "Hot fix process documentation" -> replace with System add-on documentation
  • Beta 44 Release Checklist -> updated link and reworded to not have a version number

DASHBOARD LINKS

TOOLS

OTHER

  • remove all '"B2G pages" section
  • remove Chinese repack section

Get a slot on wikimo front page

We should have a slot on the wiki front page for discoverability of the pages that our devs and contributors are always looking for, namely:

  • Release owners
  • Release Calendar
  • Release Notes
  • Release process

The front page is not editable and clearly unmaintained so we need to check who can update it or if we can get editing rights on it.

Create header template on wiki for pages needing an update

Similarly to the header template indicating that a page is obsolete and no longer relevant, I think we need a template indicating that a page content is still OK but may not be completely accurate or current. We have pages which last update is like 2014 altough what is described looks mostly correct to me.

Something along the lines of:

Warning: Our team is working on updating all of our Release Management documentation. This page hasn't been udated recently and may not be 100% up to date or accurate. In case of doubt, don't hesitate to contact our release managers directly.

Release notes page, dot releases

  • For a dot release, we add the bug numbers to each note
  • Add a link to the main note: Reference link to 60.0 release notes
    -> mark it as release specific, no tag

Create a page that describes the documentation writing process itself

https://wiki.mozilla.org/Release_Management/Documentation_guidelines
So as to have some consistency in documentation and share knowledge, we should have a page explaining how to create documentation for our team on the wiki.

  • Explain the various header templates we have (stub, obsolete, in progress)
  • All pages should be in the Release_Management namespace
  • Explain which categories we use: currently only Processes and the general Release_Management one
  • Explain how to redirect an existing page
  • Explain how to rename a page
  • Explain the "summarized process" part of process pages
  • Styling tips (see with Liz)
  • List channel versions templates

Create a category for Processes

All pages which document a process should be indexed in a special category page, this way we have a dynamic list of all our processes.
[[Category:Release_Management:Processes]]

Team_members update

Source: https://wiki.mozilla.org/index.php?title=Release_Management/Team_members&oldid=1167777

TODO

  • Add RyanVM to the team
  • Put Team blogs before Alumnis
  • Remove Alumni blogs
  • Add the Team blog and twitter account
  • Add missing blogs
  • Put a link back to "how to contact us" on the main page
  • Team image too big maybe center it as well
  • Add that it depends on the Product Integrity department
  • Replace all the "Desktop & Mobile RM" by "Firefox RM"
  • Add Philipp to the team listed as volunteer
  • Move Gerry to alumni
  • More generic title for engineers now that code coverage, static analysis move to another team
  • Need an updated picture of the team
  • Added Bastien
  • Updated Pascal role
  • Create a managers section, list both Sylvestre and Ritu there

QUESTIONS

  • Add timezone next to member?

Release_Process.wiki cleanup

Source page
https://wiki.mozilla.org/index.php?title=Release_Management/Release_Process&oldid=1187936

TODO

  • Remove aurora description link and all aurora mentions
  • Update Main repositories graphics to remove the Aurora branch
  • Reword text everywhere to say "Firefox for Desktop" (official name) instead of "Desktop Firefox"
  • Remove hardcoded en-US in download links
  • Replace Aurora download link by Dev Edition download link
  • Remove FTP download links
  • Add Firefox Nightly download link on Google Play
  • Update Nightly builds frequency
  • Remove Rapid Release graphics
  • Remove B2G IRC channel
  • Add Nightly release notes
  • Use https links everywhere
  • Fix template issues with wiki redirects
  • Remove Land Patch picture
  • Document that Dev Edition b1 & b2 are a pre-beta channel
  • Updated Bugzilla screenshots
  • the "Firefox Beta is released every week leaving us with six to eight betas every cycle unless we have chemspills leading to additional betas" sentence is wrong, there's 2 beta builds per week for desktop
  • mention that beta1&beta2 are dev edition only, and beta3 is only a subset of beta users
  • status-firefoxN flags are not all documented
  • Tracking flag guidelines blog post no longer exist but it is archived here https://web.archive.org/web/20160417051846/https://blog.mozilla.org/channels/2011/06/01/more-details-about-how-to-use-the-tracking-firefox-bugzilla-flag/
  • Document that we have no string freeze
  • Document Nightly soft freeze, found this https://mail.mozilla.org/pipermail/firefox-dev/2017-May/005433.html we should check that no change to the process was done later
  • The length of the Nightly code freeze is not clear, we announced to devs 1 week in 2017 but it is almost 2 weeks for 60 and 61, moreover 62 has 26 days of Nightly code freeze in the calendar, bug?

QUESTIONS

  • More developer edition data?
  • Document week of release branch merges?
  • put a more detailed timeline?

OTHER INFORMATION

jlorenzo's schema https://bug1430593.bmoattachments.org/attachment.cgi?id=8942658

Nightly Code Soft freeze ends when we change the version number on merge day in mozilla-central, the Monday.

Inventory of our Wiki pages and action items

https://wiki.mozilla.org/Category:Release_Management

(items dealt with in a specific issue should have their checkbox selected)

TODO


Add Obsolete warning at top:

Oldest pages : add Update Needed warning at top:

Needs a clean up

Needs new content

Needs content merged

Belongs to Other teams but categorized as Release Management

Needs a discussion

Release notes page

Clarify that people have to click on the "add to comment" link to get a form prefilled in the comment.

Update Onboarding page

https://wiki.mozilla.org/index.php?title=Release_Management/Onboarding&oldid=1191787

  • "Ask your manager for the permissions to access the Google drive" -> 404
  • Update all internal wiki links listed as external links
  • Mailing lists: we have 2 for relman now, update
  • mozilla.dev.tree-management -> no longer exists it seems
  • Metrics links is 404
  • Update all links to https
  • Add link to wiki account creation
  • Add slack info and slack channels (release-coodination)
  • are all IRC channels still used?
  • Link to general IRC page with all the clients informations instead of giving examples
  • We still have a dashboard on aha? Okta?
  • Install nightly, not aurora
  • Add Linux install link for VPN
  • Updates needed to query lists
  • "Repos to check out" -> most repos are wrong
  • Keep community contributors section?
  • "Links to get started' -> half are obsolete
  • Remove Spadina vidyo room
  • moco IRC link to mana is wrong, should be https://mana.mozilla.org/wiki/display/AVSE/MoCo+Vidyo+Room+and+%23moco+IRC+Channel+Security
  • Ship it access bug is old, maybe move to jcristau's.
  • Add link to documentation for VPN (even though it is currently completely wrong, it links to a bug where the new documentation is being created)
  • Update list of tools a RM needs access to (Ship it, Nucleus, Trello, Balrog, Security bugs, Bugzilla RM rights, Google Play) and how to get them
  • Add list of weekly meetings a RM should attend
  • add ProgramManagement to vidyo rooms
  • Merge the 2 VPN sections
  • Add a Github section
  • Add access to Ubuntu Snap into list of tools to have access to
  • Ask your manager to give you access to the Release Managers PTO calendar
  • Add that you should subscribe to your trello release column (like Firefox 63) to receive update notifications
  • Subscribe to https://mail.mozilla.org/listinfo/release-signoff

glossary page

Chemspill, nightly soft freeze, relman, acronyms, internal tools names such as Balrog or Nucleus, jargon. I think we should have a glossary page.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.