diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/developer/tests/test-syntax-highlighting.md | 2 | ||||
| -rw-r--r-- | doc/help/Markdown.md | 2 | ||||
| -rw-r--r-- | doc/help/Messaging.md | 34 | ||||
| -rw-r--r-- | doc/help/Sign-in.md | 2 | ||||
| -rw-r--r-- | doc/install/Production-Debian.md | 3 | ||||
| -rw-r--r-- | doc/install/Production-Ubuntu.md | 3 | ||||
| -rw-r--r-- | doc/process/accepting-pull-request.md | 28 | ||||
| -rw-r--r-- | doc/process/release-process.md | 141 |
8 files changed, 134 insertions, 81 deletions
diff --git a/doc/developer/tests/test-syntax-highlighting.md b/doc/developer/tests/test-syntax-highlighting.md index 7f8f4cdaa..b1568c385 100644 --- a/doc/developer/tests/test-syntax-highlighting.md +++ b/doc/developer/tests/test-syntax-highlighting.md @@ -133,7 +133,7 @@ echo "Hello World" ### CoffeeScript -``` coffee +``` coffeescript console.log(“Hello world!”); ``` diff --git a/doc/help/Markdown.md b/doc/help/Markdown.md index 64ce4fc83..d185a4160 100644 --- a/doc/help/Markdown.md +++ b/doc/help/Markdown.md @@ -31,7 +31,7 @@ code block To add syntax highlighting, type the language to be highlighted after the ``` at the beginning of the code block. Supported languages are: -`diff, apache, makefile, http, json, markdown, javascript, css, nginx, objectivec, python, xml, perl, bash, php, coffee (CoffeeScript), cs (C#), cpp (C++), sql, go, ruby, java, ini, latex` +`diff, apache, makefile, http, json, markdown, javascript, css, nginx, objectivec, python, xml, perl, bash, php, coffeescript, cs (C#), cpp (C++), sql, go, ruby, java, ini, latex` Example: diff --git a/doc/help/Messaging.md b/doc/help/Messaging.md index 548892650..2063ad41c 100644 --- a/doc/help/Messaging.md +++ b/doc/help/Messaging.md @@ -1,18 +1,18 @@ # Messaging -## Writing Messages +### Writing Messages -You can write messages using the input box with the text "Write a message..." at the bottom of Mattermost. +You can write messages using the input box with the text "Write a message..." at the bottom of Mattermost. -Press **ENTER** to send a message. Use **Shift+ENTER** to create a new line without sending a message. +Press **ENTER** to send a message. Use **Shift+ENTER** to create a new line without sending a message. -## Formatting Messages +### Formatting Messages -Mattermost messages are formatted using a standard called "markdown". Here are examples: +Mattermost messages are formatted using a standard called "markdown". Here are examples: | Text Entered | How it appears | |:---------------|:---------------| -|`**bold**`| **bold** | +|`**bold**`| **bold** | | `_italic_`|_italic_| |`[hyperlink](http://mattermost.org)`|[hyperlink](http://mattermost.org)| |``|| @@ -21,27 +21,27 @@ Mattermost messages are formatted using a standard called "markdown". Here are e Emojis provided free from [Emoji One](http://emojione.com/). Check out a full list of Emojis [here](http://emoji.codes/). -## Mentioning Teammates +### Mentioning Teammates -You can mention a teammate by using the `@` symbol plus their username to send them a special notification to draw their attention. +You can mention a teammate by using the `@` symbol plus their username to send them a special notification to draw their attention. -For example, you might write: +For example, you might write: ``` @alice how did your interview go with the new candidate? -``` +``` -Which sends a special mention notification to **alice** to check your message. +Which sends a special mention notification to **alice** to check your message. -To mention a teammate, press `@` and you should see a list of team members who can be messaged. You can either type their username or use the **Up** and **Down** arrow keys and then **ENTER** to select them to be mentioned. +To mention a teammate, press `@` and you should see a list of team members who can be messaged. You can either type their username or use the **Up** and **Down** arrow keys and then **ENTER** to select them to be mentioned. -You can configure how you'd like to be alerted about mentions of your username, your first name, your nickname, or other keywords from **Account Settings** > **Notifications** and you can set channel-specific preferences from **[Channel Name]** > **Notification Preferences** +You can configure how you'd like to be alerted about mentions of your username, your first name, your nickname, or other keywords from **Account Settings** > **Notifications** and you can set channel-specific preferences from **[Channel Name]** > **Notification Preferences** -## Messages Dropdown Menu +### Messages Dropdown Menu -To get to the Messages Dropdown Menu, hover over a message and click on the [...] menu. This shows a dropdown list containing additional actions you can perform on a message: +To get to the Messages Dropdown Menu, hover over a message and click on the [...] menu. This shows a dropdown list containing additional actions you can perform on a message: - **Reply:** Opens up the sidebar so you can reply to a message in a comment thread. -- **Permalink:** Creates a link to the message. Sharing this link with other users in the channel lets them view the linked message in the Message Archives. -- **Delete:** Deletes the message so it is no longer visible. Team Administrators and System Administrators can also delete another user's message. +- **Permalink:** Creates a link to the message. Sharing this link with other users in the channel lets them view the linked message in the Message Archives. +- **Delete:** Deletes the message so it is no longer visible. Team Administrators and System Administrators can also delete another user's message. - **Edit:** Lets you edit your own message. diff --git a/doc/help/Sign-in.md b/doc/help/Sign-in.md index 5b7b375c7..3b91af1fc 100644 --- a/doc/help/Sign-in.md +++ b/doc/help/Sign-in.md @@ -24,4 +24,4 @@ If your account in a given team has been given the System Administrator role, it #### Logging Out -You can log out from the main menu, which is accessed by clicking the three dots in the top header on the left side of the screen. Clicking "Logout" logs you out of all the teams you are signed-in to that share the same email address. +You can log out from the main menu, which is accessed by clicking the three dots in the top header on the left side of the screen. Clicking "Logout" logs you out of all teams that are signed-in and open in your browser. diff --git a/doc/install/Production-Debian.md b/doc/install/Production-Debian.md index e97f3188b..13ff051a3 100644 --- a/doc/install/Production-Debian.md +++ b/doc/install/Production-Debian.md @@ -269,7 +269,8 @@ exit 0 ssl_protocols SSLv3 TLSv1 TLSv1.1 TLSv1.2; ssl_ciphers "HIGH:!aNULL:!MD5 or HIGH:!aNULL:!MD5:!3DES"; ssl_prefer_server_ciphers on; - + ssl_session_cache shared:SSL:10m; + # add to location / above location / { gzip off; diff --git a/doc/install/Production-Ubuntu.md b/doc/install/Production-Ubuntu.md index d6b98981c..1022f30cf 100644 --- a/doc/install/Production-Ubuntu.md +++ b/doc/install/Production-Ubuntu.md @@ -164,7 +164,8 @@ exec bin/platform ssl_protocols TLSv1 TLSv1.1 TLSv1.2; ssl_ciphers 'EECDH+AESGCM:EDH+AESGCM:AES256+EECDH:AES256+EDH'; ssl_prefer_server_ciphers on; - + ssl_session_cache shared:SSL:10m; + # add to location / above location / { gzip off; diff --git a/doc/process/accepting-pull-request.md b/doc/process/accepting-pull-request.md new file mode 100644 index 000000000..f2bbb3f05 --- /dev/null +++ b/doc/process/accepting-pull-request.md @@ -0,0 +1,28 @@ +# Accepting Pull Requests (APRs) + +Per the [Contributor Guide](https://github.com/mattermost/platform/blob/master/CONTRIBUTING.md), only PRs that reference Jira tickets with the "accepting pull requests" label should be submitted to this repo. This system ensures: + +1. Proposed changes have been thoughtfully reviewed +2. Proposed changes can be tested, documented, and supported by volunteers +3. The change meets the [fast, obvious, forgiving](http://www.mattermost.org/design-principles/) design principle for the project. +4. The change [aligns to the stated purpose of the project](http://www.mattermost.org/vision/#mattermost-teams-v1) + +Key contributors and core team members are responsible opening Jira tickets that meet the above requirements, which are then reviewed in triage meetings. + +When opening Jira tickets for accepting-pull-requests, please: + +1. Use titles that clearly describe the needed change and its value +2. Include (Proposed APR) in title, so triage team knows to add the APR tag if appropriate +3. Provide unambiguous description so that feature can be tested by any volunteer +4. Link back to community discussions related to this change +5. Apply "accepting-pull-requests", and optionally as "good-first-contribution". +6. Post link back to community channels + +Example of post back to the community: + +``` +Thanks @[USERNAME], + +I created a ticket [for accepting pull requests on this issue](http://link). It will be reviewed in the triage meeting for addition to [the Accepting Pull Requests issues list](https://mattermost.atlassian.net/browse/PLT-797?filter=10101). [Code Contribution Guidelines](https://github.com/mattermost/platform/blob/master/CONTRIBUTING.md) are available for anyone interested in contributing to this project. +``` + diff --git a/doc/process/release-process.md b/doc/process/release-process.md index 96bd2b050..294f5aa79 100644 --- a/doc/process/release-process.md +++ b/doc/process/release-process.md @@ -1,68 +1,81 @@ -We're working on making internal processes in the Mattermost core team more transparent for the community. Below is a working draft of our software development process, which will be updated live as we refine our process. - -Questions, feedback, comments always welcome, - ----------- +# Mattermost Release Process Mattermost core team works on a monthly release process, with a new version shipping on the 16th of each month. This document outlines the development process for the Mattermost core team, which draws from what we find works best for us from Agile, Scrum and Software Development Lifecycle approaches. -This is a working document that will update as our process evolves. - +Notes: +- All cut-off dates are based on 10am PST (UTC-07/08) on the day stated. +- T-minus counts are measured in "working days" (weekdays other than major holidays concurrent in US and Canada) prior to release day. -### - Beginning of release -- (Ops) Queue an agenda item for first team meeting of the release to review Roadmap +### (Code complete date of previous release) Beginning of release +- Pre-work for the current release begins at the code complete date of the previous release. See "Code Complete" section below for details. -### - (10 weekdays before release date) Cut-off for major features -- No major features can be committed to the current release after this date -- (Dev) Prioritize reviewing, updating, and merging of all pull requests that are going to make it into the release - - There should be no more tickets in the [pull request queue](https://github.com/mattermost/platform/pulls) marked for the current release +### (T-minus 10 working days) Cut-off for major features +- No pull requests for major features should be submitted to the current release after this date (except if release manager decides to add "release-exception" label) +- (Ops) Post this checklist in Release channel +- (PM) Write compatibility updates for config.json and database changes [See example](https://github.com/mattermost/platform/blob/master/CHANGELOG.md#compatibility) +- (PM) Confirm changes to config.json in compatibility section of Changelog are written back to [settings documentation](https://github.com/mattermost/platform/blob/master/doc/install/Configuration-Settings.md) +- (Dev) Prioritize reviewing, updating, and merging of pull requests for current release until there are no more tickets in the [pull request queue](https://github.com/mattermost/platform/pulls) marked for the current release - (Leads) Meets to prioritize the final tickets of the release - Backlog is reviewed and major features that won’t make it are moved to next release - Triage tickets - - Review roadmap for next release -- (Marketing) Writes the "Highlights" section of the Changelog -- (PM) Write compatibility updates for config.json and database changes [See example](https://github.com/mattermost/platform/blob/master/CHANGELOG.md#compatibility) + - Finalize roadmap for next release + - Draft roadmap for release after next (used to prioritize design tasks) +- (Marketing) Drafts marketing bullet points for next release based off of roadmap +- (Marketing) Submits pull request for "Highlights" section of the Changelog +- (Marketing) Notes date of announcements in release channel - (PM) Update [Upgrade Guide](https://github.com/mattermost/platform/blob/master/doc/install/Upgrade-Guide.md) for any steps needed to upgrade to new version -- (PM) Prepare tickets for cutting RCs builds, filing issue in GitLab omnibus to take RC candidate, testing GitLab RC with Mattermost -- (Stand-up) Each team member discusses worst bug - -### - (8 weekdays before release date) Feature Complete and Stabilization -- After the cut-off time for Feature Complete, Dev prioritizes reviewing PRs and committing to master so Stabilization period can begin, with testing and high priority bug fixes -- During Stabilization period only BUGS can be committed to master, non-bug tickets are tagged for next version and wait until after a release candidate is cut to be added to master - - (PM) Review all [S1 bugs](https://mattermost.atlassian.net/secure/IssueNavigator.jspa?mode=hide&requestId=10600) and mark important ones as high priority - - (Dev + PM) Exceptions can be made by triage team consensus across PM and Dev. List of approved changes for release candidate 1 here: https://mattermost.atlassian.net/issues/?filter=10204 -- (PM) Documentation +- (PM) Prepare tickets for [cutting RC builds](https://mattermost.atlassian.net/browse/PLT-985), [creating the final release candidate](https://mattermost.atlassian.net/browse/PLT-986), [creating AMIs](https://mattermost.atlassian.net/browse/PLT-1213), and [testing GitLab RC with Mattermost](https://mattermost.atlassian.net/browse/PLT-1013) +- (Stand-up) Each team member discusses worst bug (10-15s) + +### (T-minus 8 working days) Feature Complete and Stabilization +- No pull requests for features can be submitted to the current release after this date (except if release manager add "release-exception" label to Jira ticket) +- (Ops) Post this checklist in Release channel +- (Dev) Prioritize reviewing, updating, and merging of pull requests for current release until there are no more tickets in the [pull request queue](https://github.com/mattermost/platform/pulls) marked for the current release +- **Stablization** period begins when all features for release have been committed. + - During this period, only **bugs** can be committed to master. Non-bug pull requests are tagged for next version and wait until after a release candidate is cut to be committed to master + - (RM) Exceptions can be made by release manager by setting priority to "Highest" and labelling "release-exception", which will add ticket to [Hotfix list for release candidate](https://mattermost.atlassian.net/issues/?filter=10204). + - (PM) Review all [Severity 1 bugs (data loss or security)](https://mattermost.atlassian.net/secure/IssueNavigator.jspa?mode=hide&requestId=10600) to consider for adding to Hotfix list. +- (PM) Complete documentation - (PM) Make Changelog PR with updates for latest feature additions and changes - (PM) Make Changelog PR with updates to contributors - (PM) Make NOTICE.txt PR for any new libraries added from dev, if not added already - (PM) Prioritize any developer documentation tickets -- (PM and devs) Sign-off testing of their feature areas (i.e. PM/dev either signs-off that their area is well tested, or they flag that potential quality issues may exist) -- (Ops) Mail out mugs to any new contributors -- (Team) Select "Top Contributor" for the release from external contributions to be mentioned in release announcement -- (Marketing) Decides announce date (discuss in meeting) + - (PM) Draft [GitLab ticket](https://gitlab.com/gitlab-org/omnibus-gitlab/issues/942) to take next Mattermost version in the Omnibus, but do not post until RC1 is cut +- (PM) Check testing is complete + - (PM) Works with Ops to check the [Quality Gate](https://github.com/mattermost/process/blob/master/release/quality-gates.md) for feature complete + - (PM + Dev) Sign-off testing of their feature areas (i.e. PM/dev either signs-off that their area is well tested, or they flag that potential quality issues may exist) +- **(Team) Feature Complete Meeting (10:15am PST)** + - (PM) Leads review of Changelog + - (Team) Each team member discusses worst bug (10-15s) + - (PM) Review feature list for next release + - (Marketing) Share draft of marketing announce for next release +- (Marketing) Communicates checklist of items needed by specific dates to write the blog post announce (e.g. screenshots, GIFs, - (Ops) Post Announce Date in Release channel + update the channel header to reflect date -- (Marketing) Communicates checklist of items needed by specific dates to write the blog post announce (e.g. screenshots, GIFs, documentation) and begins to write the blog post, tweet, and email for the release announcement -- (PM) Works with Ops to check the Quality Gate for feature complete -- (PM) Communicate to team the plan for next release -- (Stand-up) Each team member discusses worst bug +- (Ops) Mail out mugs to any new contributors -### - (5 weekdays before release date) Code Complete and Release Candidate Cut -- (Team) Meets to discuss release at 10am PST - - (PM) Each area changed in latest release is assigned a PM owner to lead testing - - (Ops) Walks through each item of the **Code Complete and Release Candidate Cut** checklist +### (T-minus 5 working days) Code Complete and Release Candidate Cut +- (Ops) Post this checklist in Release channel +- (Ops) For the next release, create team meetings on Feature Complete and Code Complete dates +- (PM) Remove "Under Development" notice for current release from Changelog on master +- **(Team) Code Complete Meeting (10:15am PST meeting)** + - (Ops) Walks through each item of this checklist + - (PM) Assigns each area of the release testing spreadsheet to a team member - (Dev) Last check of tickets that need to be merged before RC1 - - (Team) Each team member discusses worst bug -- After 10am PST meeting the release is considered “Code Complete”. - - (Dev) Completes final reviews and updates of PRs marked for the release version - - There should be no more tickets in the [pull request queue](https://github.com/mattermost/platform/pulls) marked for the current release - - Master is tagged and branched and “Release Candidate 1″ is cut (e.g. 1.1.0-RC1) according to the Release Candidate Checklist + - (Team) Each team member discusses worst bug (10-15s) +- **Code Complete** is declared after meeting + - (Dev) Prioritize reviewing, updating, and merging of pull requests for current release until there are no more tickets in the [pull request queue](https://github.com/mattermost/platform/pulls) marked for the current release + - (Build) Master is tagged and branched and “Release Candidate 1″ is cut (e.g. 1.1.0-RC1) according to the [Release Candidate Checklist](https://github.com/mattermost/process/blob/master/release/create-release-candidate.md) - (PM) Create meta issue for regressions in GitHub (see [example](https://github.com/mattermost/platform/issues/574)) - -### - (4 weekdays before release date) Release Candidate Testing -- Final testing is conducted by the team on the acceptance server and any issues found are filed - - (Dev) Tests upgrade from previous version to current version, following the [Upgrade Guide](https://github.com/mattermost/platform/blob/master/doc/install/Upgrade-Guide.md) + - (PM) Include link to meta-issue in release notes of RC1 + - (PM) Tweet announcement that RC1 is ready (see [example](https://twitter.com/mattermosthq/status/664172166368264192)) + - (PM) Submit GitLab ticket to take next Mattermost version in the Omnibus + +### (T-minus 4 working days) Release Candidate Testing +- (Team) Final testing is conducted by the team on the acceptance server and any issues found are filed +- (Build) Tests upgrade from previous version to current version, following the [Upgrade Guide](https://github.com/mattermost/platform/blob/master/doc/install/Upgrade-Guide.md) + - Database upgrade should be tested on both MySQL and Postgres - (Ops) Posts copy of the **Release Candidate Testing** checklist into Town Square in PRODUCTION - (Ops) Moves meeting, test and community channels over to the production version of RC, and posts in Town Square asking everyone to move communication over to the new team for testing purposes - (PM) Test feature areas and post bugs to Bugs/Issues in PRODUCTION @@ -72,6 +85,7 @@ This is a working document that will update as our process evolves. - (PM) Posts links to all issues found in RC as comments on the meta issue - (PM) Updates description to include approved fixes - (PM) Posts screenshot and link to final tickets for next RC to the Release room + - (PM) Updates Release Notes with any new issues that will not be fixed for the current version - (PM & DEV leads) Triage hotfix candidates and decide on whether and when to cut next RC or final - (Dev) PRs for hotfixes made to release branch, and changes from release branch are merged into master - (Ops) Tests approved fixes on master @@ -81,19 +95,28 @@ This is a working document that will update as our process evolves. - (Ops) verifies each of the issues in meta ticket is fixed - (PM) If no blocking issues are found, PM, Dev and Ops signs off on the release -### - (2 weekdays before release date) Release - - (Dev) Tags a new release (e.g. 1.1.0) and runs an official build which should be essentially identical to the last RC +### (T-minus 2 working days) Release Build Cut +- (Ops) Post this checklist in Release channel +- (Build) Tags a new release (e.g. 1.1.0) and runs an official build which should be essentially identical to the last RC - (PM) Any significant issues that were found and not fixed for the final release are noted in the release notes - - If an urgent and important issue needs to be addressed between major releases, a hotfix release (e.g. 1.1.1) may be released, however this should be very rare, given a monthly cadence - - (PM) Copy and paste the Release Notes from the Changelog to the Release Description - - (PM) Update the mattermost.org/download page - - (Dev) Delete RCs after final version is shipped - - (PM) Close final GitHub RC meta ticket - -### - (0 weekdays before release date) End of Release -- (PM) Makes sure marketing has been posted (animated GIFs, screenshots, mail announcement, Tweets, blog posts) + - If an urgent and important issue needs to be addressed between major releases, a bug fix release (e.g. 1.1.1) may be created +- (PM) Copy and paste the Release Notes from the Changelog to the Release Description +- (PM) Update the mattermost.org/download page +- (PM) Update the AMI links on mattermost.org/installation +- (PM) Close final GitHub RC meta ticket +- (Dev) Delete RCs after final version is shipped +- (Marketing) Finalize marketing + - (Marketing) Finalize mailchimp email blast + - (Marketing) Finalize blog post and put on timer for release + - (Marketing) Finalize tweet announcement + - (Marketing) Finalize announcement on general mailing list + - (Marketing) Finalize announcement for gitlab.mattermost.com + +### (T-minus 0 working days) Release Day +- (Ops) Post this checklist in Release channel +- (PM) Confirm marketing has been posted (animated GIFs, screenshots, mail announcement, Tweets, blog posts) - (PM) Close the release in Jira +- (PM) Set header of next release as UNDER DEVELOPMENT in CHANGELOG on master - (Dev) Check if any libraries need to be updated for the next release, and if so bring up in weekly team meeting -- (Ops) Post important dates for the next release in the header of the Release channel -- (Ops) Queue an agenda item for next team meeting for "Stepping Back" Q&A -- (Ops) Queue an agenda item for next team meeting for Roadmap review +- (Ops) Post key dates for the next release in the header of the Release channel +- (Ops) Queue an agenda item for next team meeting for Release Process Kaizen/Q&A |