Skip to content

Commit e59f05d

Browse files
committed
Issue #4861: Move procedural docs to wiki.
1 parent 229fc0d commit e59f05d

17 files changed

+22
-604
lines changed

procedures/README.md

Lines changed: 6 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,8 @@
1-
Procedural Documents
2-
=====================
3-
4-
A centralized place to store and manage documents that list the steps required
5-
for maintaining the Backdrop CMS open source project.
6-
7-
These documents exist so that we don't have single points of failure should the
8-
people responsible for doing these tasks be unavailable for any reason.
9-
10-
Task Lists included
11-
-------------------
12-
13-
### Issue templates
14-
15-
- Creating a major release x.0.0
16-
- Creating a minor release 1.x.0
17-
- Creating a bug-fix release 1.x.y
18-
- Crossports from Drupal 7
19-
20-
### Core committer docs
21-
22-
- How to make commits to Backdrop core
23-
24-
### Updating Backdrop core internal libraries
25-
26-
- How to update CKEditor
27-
- @todo How to update jQuery and jQueryUI
28-
29-
### Updating remote Backdrop sources
30-
31-
- How to update the Docker image
32-
- How to update the Pantheon upstream
33-
- How to update the Platform.sh template
34-
- How to update the TugBoat repo
35-
36-
### Weekly Meetings
37-
38-
- How to run a weekly meeting
39-
- How to update the agenda for a weekly meeting
1+
Issue Templates
2+
===============
403

4+
A centralized place to store and manage templates used to create issues for
5+
releases, etc.
416

7+
This repo was previously also used to store procedural documents, but they've
8+
since been moved to the wiki: https://github.com/backdrop/backdrop-issues/wiki
Lines changed: 1 addition & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1 @@
1-
2-
Backdrop Core Commit Procedure
3-
==============================
4-
5-
For a particular pull request (PR):
6-
7-
* Make sure the logic is sound and simple
8-
* Make sure it meets Backdrop's [coding & documentation standards](https://api.backdropcms.org/documentation/coding-and-documentation-standards)
9-
* Make sure it passes automated tests
10-
* Assess whether it needs a new test(s) (usually when it introduces new functionality)
11-
* Test the PR manually in the PR sandbox
12-
* Test the PR manually in your local environment
13-
* Verify the problem (e.g. check `/admin/reports/dblog` for errors/warnings)
14-
* Pull down the PR or apply the patch
15-
* Verify the fix/feature
16-
* Make sure you're familiar with the [merging guidelines](https://gist.github.com/quicksketch/d633d8f850fd11b2ef5f222aa0a3b5af) (summarized below)
17-
* Merge into `1.x`
18-
* Use the 'Squash and merge' button in the PR
19-
* Make sure the commit message follows the pattern: `Issue #XXXX: Fix type on /admin/blah.` (it should be a complete sentence)
20-
* Add a commit description giving credit to the people involved (e.g. `By @jenlampton, @quicksketch & @klonos`)
21-
* Bug fixes/tasks also get merged into the latest version branch (`1.y.x`)
22-
* ```php
23-
# Make sure 1.y.x is up-to-date
24-
git checkout 1.y.x
25-
git pull backdrop 1.y.x
26-
# Pull down latest commits on 1.x.
27-
git fetch backdrop
28-
git cherry-pick [commit-hash]
29-
git push backdrop 1.y.x
30-
```
31-
* Post a message in the PR saying which branches it's been merged into
32-
* Post a message in the linked issue thanking everyone involved (by name) and mentioning which PR was merged and into which branches.
1+
Moved to: https://github.com/backdrop/backdrop-issues/wiki/Core:-Commit-Procedure

procedures/core--release-notes.md

Lines changed: 1 addition & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1 @@
1-
# Bug-Fix Release notes
2-
3-
1) Git clone repository for backdrop/backdrop (or git pull 1.x branch)
4-
Run the command `git pull core 1.x`
5-
(where 'core' is the remote and '1.x' is the branch)
6-
2) Checkout the latest bug-fix branch
7-
Run the command `git checkout 1.11.x`
8-
(where 1.11.x is the latest bug-fix branch)
9-
3) Get all the latest tags
10-
Run the command `git fetch --tags`
11-
4) Generate release notes
12-
Run the command `drush rn 1.11.3 HEAD > ~/Desktop/notes.md`
13-
(where 1.11.3 is the latest release)
14-
15-
16-
# Minor Version Release notes
17-
18-
The release notes for minor versions are generated automatically, based on
19-
issues assigned to the minor version's milestone.
20-
21-
1) Go to the 'Milestones' page in the `backdrop-issues` repo:
22-
https://github.com/backdrop/backdrop-issues/milestones
23-
2) Close the milestone for this minor version (this triggers the generation of
24-
the release notes)
25-
3) Go to the 'Actions' page in the `backdrop-issues` repo:
26-
https://github.com/backdrop/backdrop-issues/actions
27-
4) A 'Release Notes Generator' workflow should be in progress - wait until it's
28-
done, then click on it
29-
5) Scroll down to the 'Artifacts' section and click on the 'release-notes'
30-
download - this ZIP file contains a markdown file with the generated release
31-
notes for this minor version
1+
Moved to: https://github.com/backdrop/backdrop-issues/wiki/Core:-Release-Notes

procedures/event--backdrop-live.md

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1 @@
1-
2-
Steps to create an online Backdrop LIVE event
3-
------------------------------------------------
4-
5-
- [ ] Disable the "Schedule" link in the menu (if not done already)
6-
- [ ] Decide on a date
7-
- [ ] Create an "Event" node, and set the date.
8-
- [ ] Set registration detils, at node/[nid]/registrations/settings
9-
- Confirm that "Enable" box is checked
10-
- Confirm registration open/close dates
11-
- Review confirmation email text
12-
- [ ] Set the default values for event-reference fields (this is a private
13-
field and only administrators will be able to change it).
14-
- [ ] Discussions - Update event default.
15-
- [ ] Presentations - Update event default.
16-
- [ ] Edit the "Schedule" view.
17-
- change the filter for "event" to the current event node
18-
19-
1+
Moved to: https://github.com/backdrop/backdrop-issues/wiki/Event:-Backdrop-Live
Lines changed: 1 addition & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1 @@
1-
2-
Adding a new Core committer
3-
===========================
4-
5-
When a new core committer is added to the team, there are a number of places
6-
they need to be included, and things that need to be udpated, as follows:
7-
8-
1) Update the leadership page backdropcms.org/leadership so that everybody knows
9-
that they are a core committer.
10-
11-
1) Add the new person to the backdrop/backdrop repository, so that they can have
12-
commit access to core code.
13-
14-
1) Add the new person to the Backdrop Security Team located at
15-
https://github.com/orgs/backdrop-ops/teams/security, so that they can help
16-
coordinate security releases, and contribute to security fixes.
17-
18-
1) Add the new person to the backdrop-ops/leadership repository, so that they
19-
can have access to all the issues where PMC + Core committers collaborate.
20-
21-
1) Add the person's preferred email address to the core commiter group email
22-
forwarding, set up at NameCheap.
23-
24-
1) (Until we choose a better chat tool that integrates with GitHub)
25-
a) Manually add the new person to the private "Core committers" chat channel.
26-
b) Manually add the new person to the private "Leadership" chat channel.
1+
Moved to: https://github.com/backdrop/backdrop-issues/wiki/Leadership:-Add-Core-Committer
Lines changed: 1 addition & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1 @@
1-
2-
Adding a new PMC Member
3-
=======================
4-
5-
When a mew PMC member is added to the team, there are a number of places they
6-
need to be included, and things that need to be udpated, as follows:
7-
8-
1) Update the leadership page backdropcms.org/leadership so that everybody knows
9-
that they are a part of the team.
10-
11-
2) Add the new person to the backdrop-ops/pmc repository, so that they can have
12-
access to all the PMC issues.
13-
14-
3) Add the new person to the backdrop-ops/leadership repository, so that they
15-
can have access to all the issues where PMC + Core committers collaborate.
16-
17-
4) Add the person's preferred email address to the pmc member group email
18-
forwarding, set up at NameCheap.
19-
20-
5) Add the new PMC member as a signatory on the fiscal sponsorship agreement
21-
between Backdrop CMS and the Software Freedom Conservancy.
22-
23-
6) (Until we choose a better chat tool that integrates with GitHub)
24-
5a) Manually add the PMC member to the private "PMC" chat channel.
25-
5b) Manually add the PMC member to the private "Leadership" chat channel.
1+
Moved to: https://github.com/backdrop/backdrop-issues/wiki/Leadership:-Add-PMC-Member
Lines changed: 1 addition & 112 deletions
Original file line numberDiff line numberDiff line change
@@ -1,112 +1 @@
1-
Use case: A person wants to contribute to the Backdrop translation of a specific
2-
language.
3-
4-
## (1) Prospective contributor registers for user account
5-
6-
- The prospective contributor goes to https://localize.backdropcms.org/user/register.
7-
- They fill the form with User name, Mail address and a Message. The latter is
8-
to let the moderators know about the kind of contribution and the language
9-
they're interested in. (Example: "I'd like to submit translation suggestions
10-
for Spanish.")
11-
12-
## (2) Site manager activates the account
13-
14-
- The new account triggers the action "Send e-mail about new account to a site
15-
manager". Recipients of the action (currently [Olaf](https://github.com/olafgrabienski)
16-
and [Greg](https://github.com/klonos)) receive an email containing user
17-
information (and, in theory, the message, see https://github.com/backdrop-ops/localize.backdropcms.org/issues/35).
18-
- The site manager goes to localize.backdropcms.org/user?destination=admin/people,
19-
looks for the new account, and (until https://github.com/backdrop-ops/localize.backdropcms.org/issues/35
20-
is fixed) looks for the message of the prospective contributor.
21-
- If the registration and the message look good, the site manager activates the
22-
account.
23-
24-
## (3) Site manager checks for language and translation group
25-
26-
Depending on the contributor message, there are two possible situations: the
27-
language of interest exists on the translation server, or it doesn't exist yet.
28-
If it doesn't exist, the language and the respective translation group have to
29-
be created first:
30-
31-
- Go to https://localize.backdropcms.org/admin/config/regional/language/add, and
32-
add a new language.
33-
- Go to https://localize.backdropcms.org/node/add/l10n-group, and add a
34-
translation group for the language.
35-
36-
Note: As node author, you are the first member of this group, and you'll reveive
37-
group application messages (see below).
38-
39-
## (4) Site manager gets in touch with the contributor
40-
41-
Assumption: Language and translation group exist.
42-
43-
Go to the newly activated user account (double check if it has been enabled,
44-
and enable it if not), switch to the "Contact" tab, and send a welcome message
45-
to the contributor. The text details will depend on the situation (new vs.
46-
existing language, etc.). Here's an example regarding a contributor who wants to
47-
contribute to a new language:
48-
49-
> Subject: [LANGUAGE] translation group
50-
>
51-
> Hello [USER NAME],
52-
>
53-
> Thanks for registering an account on https://localize.backdropcms.org!
54-
>
55-
> You wrote, you'd like to translate Backdrop to [LANGUAGE]. I've created the
56-
> [LANGUAGE] group and activated your user account. As a next step, please visit
57-
> https://localize.backdropcms.org/translate/languages/[LANGUAGE-CODE], look for
58-
> the group block at the bottom of the right sidebar, and apply for group
59-
> membership.
60-
>
61-
> As we're not able to evaluate translations into [LANGUAGE], it would make
62-
> sense to provide your account then with the role of a "Translation
63-
> supervisor". As a user with that role, you'd be able to translate right away,
64-
> and import language files without the need of another member to confirm your
65-
> suggestions. Are you fine with being assigned that role?
66-
>
67-
> All the best,
68-
> [NAME]
69-
70-
## (5) Manage new group membership
71-
72-
When the new contributor applies for group membership, the group author
73-
receives an email notification.
74-
75-
- Go to `group/node/NID/admin/people`, set the Status of the new member to
76-
"Active", and update the membership.
77-
- (optional) Edit the group account again, and choose an additional role,
78-
usually "translations supervisor".
79-
- Go to the user account contact tab, and send a message with instructions.
80-
Example:
81-
82-
> Subject: [LANGUAGE] translation instructions
83-
>
84-
> Hello [NAME],
85-
> Thanks for your group application! I've enabled your membership and updated
86-
> your role for the [LANGUAGE] group. You can translate single language single
87-
> strings on the page https://localize.backdropcms.org/translate/languages/[LANGUAGE]-CODE/translate,
88-
> or import .po language files with translations on the page
89-
> https://localize.backdropcms.org/translate/languages/[LANGUAGE]-CODE/import.
90-
>
91-
> By the way, if you have translation files of Drupal core, or of Drupal modules
92-
> that have been included in Backdrop core (like Views or CKEditor), you can
93-
> also import these.
94-
>
95-
> Please send me a message when you've done any import(s), or whenever you've
96-
> completed a larger quantity of translations. To make sure that these strings
97-
> show up in the download files, we have to 'repackage' the releases on the
98-
> translation server.
99-
>
100-
> All the best, and happy translating,
101-
> [NAME]
102-
103-
## (6) Repackage language release
104-
105-
When a contributor has imported or translated many language strings, the files
106-
have to be repackaged.
107-
108-
- Go to https://localize.backdropcms.org/admin/l10n_server/packager
109-
- Choose a project (usually Backdrop)
110-
- Select a language
111-
- Click "Repackage now"
112-
- Flush the "Page and else" cache
1+
Moved to: https://github.com/backdrop/backdrop-issues/wiki/Localize:-Account-Activations

procedures/release-notes.md

Lines changed: 1 addition & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1 @@
1-
# Bug-Fix Release notes.
2-
------------------------
3-
4-
1) Git clone repository for backdrop/backdrop (or git pull 1.x branch)
5-
Run the command `git pull core 1.x`
6-
where 'core' is the remote and '1.x' is the branch.
7-
2) Checkout the latest bug-fix branch.
8-
Run the command `git checkout 1.11.x`
9-
where where 1.11.x is the latest bug-fix branch.
10-
3) Get all the latest tags.
11-
Run the command `git fetch --tags`
12-
4) Generate release notes.
13-
Run the command `drush rn 1.11.3 HEAD > ~/Desktop/notes.md`
14-
where 1.11.3 is the latest release.
15-
16-
17-
# Minor Version Release notes.
18-
------------------------------
19-
20-
1) Git clone repository for backdrop/backdrop (or git pull 1.x branch)
21-
Run the command `git pull core 1.x`
22-
where 'core' is the remote and '1.x' is the branch.
23-
2) Get a list of all changes since the previous minor version
24-
Run the command `drush rn 1.11.0 HEAD`
25-
Review all the issues, remove anything that was committed to a bug-fix release
26-
27-
28-
To check for changes to files outside the core directory:
29-
30-
`git diff mybranch..1.x -- .htaccess`
31-
`git diff mybranch..1.x -- settings.php`
32-
`git diff mybranch..1.x -- robots.txt`
1+
Moved to: https://github.com/backdrop/backdrop-issues/wiki/Core:-Release-Notes
Lines changed: 1 addition & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1 @@
1-
# Request a CVE
2-
---------------
3-
4-
1) Fill out [the form to request CVE IDs](https://cveform.mitre.org/) directly from the CVE Program Root CNA (currently MITRE)
5-
6-
* Request type: Request a CVE ID
7-
* Your email address (use [email protected], or your own email)
8-
* Vulnerabiity type: pull this from the `Vulnerability` field on our SA
9-
* Vendor of the product(s): Backdrop CMS
10-
* Affected product(s)/code base:
11-
* Product: Backdrop CMS core
12-
* Version: pull this from the `Versions affected` field on our SA
13-
* Has vendor confirmed or acknowledged the vulnerability? YES (always)
14-
* Attack type: Remote (always)
15-
* Impact: only check these boxes if there are matching values in the `Vulnerability` field on our SA, otherwise tick 'Other'
16-
* Other impact: pull this from the `Vulnerability` field on our SA
17-
* Affected component(s): Answer to the best of your ability
18-
* Attack vector(s): Answer to the best of your ability
19-
* Suggested description of the vulnerability for use in the CVE: Copy the `body` from our SA
20-
* Discoverer(s)/Credits: copy from the `Reported By` field on our SA
21-
* Reference(s): Link to our SA, Link to drupal.org SA, other links as appropriate
22-
* Additional information: other info as appropriate
23-
24-
For an overview, visit the [information page](https://cve.mitre.org/cve/request_id.html)
1+
Moved to: https://github.com/backdrop/backdrop-issues/wiki/Security:-Request-CVE
Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1 @@
1-
If our disk allowance runs out, PR sandboxes fail to be generated. The process to free some space to allow PR sandboxes to be created again is as follows:
2-
3-
1. Go to https://dashboard.tugboat.qa/5f9cffcf6c879bf4534e573e
4-
2. For each preview older than X, click Actions > Delete > Yes
5-
- X is an appropriate time ago, based on the number of previews and how recent they are (e.g. the ones that are 6-9 months old)
6-
- If there is a flurry of activity, you may need to delete all previews older than 3 months, just to get us back under quota.
7-
8-
People with access to that Tugboat project currently are:
9-
- Nate (@quicksketch)
10-
- Jen (@jenlampton)
11-
- Peter (@BWPanda)
12-
- Greg (@klonos)
13-
- Dragon Bot
1+
Moved to: https://github.com/backdrop/backdrop-issues/wiki/Tugboat:-PR-Sandbox-Cleanup

0 commit comments

Comments
 (0)