Help us create relevant and useful content for developers like yourself. See something you'd like to add or change? We love pull requests!
- If you don't have one already, sign up for a GitHub account.
- Fork the pantheon-systems/documentation repository on GitHub. Trying to edit or create a file in this repository will create your fork automatically.
- Clone your fork locally.
- Add our repo as a remote.
git remote add upstream [email protected]:pantheon-systems/documentation.git.
NOTE: All contributions must be licensed under CC-BY-SA. Code snippet contributions must additionally be licensed under The MIT License. You must have permission to contribute your work under these terms.
Before you edit or create a doc, search open issues to make sure you can't find anything related to what you want to work on. If there isn't an issue, create one and add an outline for the article you want to create. This allows contributors to get some initial feedback.
###Titles and Descriptions When creating issues, add a clear title and description. Issues should contain relevant information e.g., the document title, the information that is incorrect or outdated and your suggestion on how to fix it, reasons why method A is better than method B, and so on.
Example:
Title: Apache Solr doc - Terminus command is not working
Description: The document currently suggests using XYZ commands, but I get the following error (insert error message). The fix is to use XYZ commands.
###Labels
Add labels to issues by clicking the gear in the sidebar on the right. Labels are used to signify priority, category, and to help filter existing issues. For example, if a doc is incorrect, the label 'Doc Defect' should be applied.
- Search open issues to make sure your isn't duplicated.
- Locally, cd to the
documentationrepository and usegit checkout -b <new-branch-name>to switch to a new branch. - Edit locally, commit changes, and push to your fork.
- To preserve the accuracy of promised information throughout the docs, search the repository for links to the revised section and update related articles accordingly.
From your local repo, run the following commands in order:
git checkout mastergit pull --rebase upstream mastergit push origin master
All of our documentation is generated from markdown files, found at source/docs/articles/ and source/docs/guides/. These markdown files must have front matter that allow the page to render successfully. This is required if you plan to create a new doc. Here's an example:
---
title: Starting With Git
description: Use Git version control with your Pantheon site.
category:
- getting-started
- developing
---
If you're creating your first guide, you must also create an Author profile. Fill out the information below and add it to the sculpin_site.yml file. Commit this change alongside your new guide.
your_handle:
name: Your Name
url: http://yourURL.com
avatar: http://url.to.a.valid/avatar.jpeg
twitter: http://twitter.com/
gplus: https://plus.google.com/
github: https://github.com/
linkedin: https://www.linkedin.com/in/
drupal: https://www.drupal.org/u/
wordpress: https://profiles.wordpress.org/
bio: This shouldn't be long, just a short intro.
Please provide at least "name" and "bio". The "gplus" URL is useful to show your author info on Google search results.
When you're done making changes, submit a pull request.
Some things to follow to help increase the chance that your pull request will be accepted:
- Follow our style guide.
- Write a good commit message.
- Build and test locally to make sure everything looks good. Refer to README for detailed instructions.
See the Images Readme.
Moderators will review and comment on pull requests within three business days. We may suggest changes, improvements, or alternatives in which case the original author will be tagged directly so follow-up instructions are clear. There may be times where moderators will make commits to your fork directly for clarity and/or alignment with our style guide.