Differences between revisions 7 and 8
Revision 7 as of 2014-03-31 16:42:31
Size: 3951
Editor: EverettToews
Comment:
Revision 8 as of 2014-05-02 19:27:26
Size: 3108
Editor: EverettToews
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
Contributing to the jclouds documentation site at http://jclouds.apache.org or submitting a guest blog post to http://jclouds.apache.org/blog/ is easy and can be done entirely from within your web browser. Contributing to the jclouds documentation site at [[http://jclouds.apache.org|jclouds.apache.org]] or submitting a guest blog post to [[http://jclouds.apache.org/blog/|jclouds.apache.org/blog/]] is easy and can be done entirely from within your web browser.
Line 7: Line 7:
Go to the [[https://github.com/jclouds/jclouds-site|jclouds-site]] and find the doc you want to change. The website directory structure mimics the GitHub site so files are easy to find. For example:

|| Website || http://jclouds.apache.org || [[http://jclouds.apache.org/guides/chef/|/guides/chef/]] ||
|| GitHub || https://github.com/jclouds/jclouds-site || [[https://github.com/jclouds/jclouds-site/blob/master/guides/chef.md|/guides/chef.md]] ||
Simply go to a page anywhere on the [[http://jclouds.apache.org|jclouds.apache.org]] site, scroll to the bottom of the page, and click the Fix This Page link.
Line 16: Line 13:
1. Click on the Edit button for that file.

2. Make your edits and click on the Preview button to ensure nothing is obviously wrong.

=== Add a New Page ===

1. If you want to add a new documentation file, look for the + icon at the end of the dir near the top.

{{http://i.imgur.com/LeDhmAL.png}}

2. Name the file as appropriate (e.g. my-new-provider-guide.md).

3. Make your edits and click on the Preview button to ensure nothing is obviously wrong.
1. Make your edits and click on the Preview button to ensure nothing is obviously wrong.
Line 36: Line 21:
2. Name the file similarly to the rest of the files in [[https://github.com/jclouds/jclouds-site/tree/master/_posts|the _posts directory]] (e.g. YYYY-MM-DD-check-out-how-we-use-jclouds.md). 2. Name the file similarly to the rest of the files in [[https://github.com/jclouds/jclouds-site/tree/master/_posts|the _posts directory]] (e.g. [[YYYY-MM-DD-check-out-how-we-use-jclouds.md]]).
Line 50: Line 35:
At this point a documentation build has been kicked off in the background and you need to wait ~5 minutes for the result. During the wait, we encourage you to join the user mailing list: [[mailto:jclouds-user-subscribe@apache.org|Subscribe]] ([[http://www.mail-archive.com/user@jclouds.apache.org/|Archive]]) or the dev mailing list: [[mailto:jclouds-dev-subscribe@apache.org|Subscribe]] ([[http://www.mail-archive.com/dev@jclouds.apache.org/|Archive]]). At this point a documentation build has been kicked off in the background and you need to wait ~5 minutes for the result. During the wait, we encourage you to join the [[http://jclouds.apache.org/community/|jclouds community]].

Contributing to the jclouds documentation site at jclouds.apache.org or submitting a guest blog post to jclouds.apache.org/blog/ is easy and can be done entirely from within your web browser.

Find

Simply go to a page anywhere on the jclouds.apache.org site, scroll to the bottom of the page, and click the Fix This Page link.

Change

Edit a Page

1. Make your edits and click on the Preview button to ensure nothing is obviously wrong.

Guest Blog Post

1. If you want to add a guest blog post, go directly to the _posts directory and look for the + icon at the end of the dir near the top.

http://i.imgur.com/JJpVb5W.png

2. Name the file similarly to the rest of the files in the _posts directory (e.g. YYYY-MM-DD-check-out-how-we-use-jclouds.md).

3. To get a quick start on your post you might want to copy the raw text from an existing post (e.g. 2014-03-04-jclouds-meetup.md) into the editor in your web browser and change the text.

4. Make your edits and click on the Preview button to ensure nothing is obviously wrong.

Commit

Below the editing window fill out the "Commit summary" field. If it's a big change, you can fill in the "Extended description". Click on Propose File Change (or Commit Changes if you're making an update).

On the next page follow the instructions to create a pull request.

Wait

At this point a documentation build has been kicked off in the background and you need to wait ~5 minutes for the result. During the wait, we encourage you to join the jclouds community.

Eventually you should see a comment that reads.

jclouds-site-pull-requests #39 SUCCESS
This pull request looks good

Wait a bit longer for one more comment that looks like.

Go to http://228e0faa97066fc327e5-07f246b6bd4e3aa7b5122e79013b6aae.r74.cf1.rackcdn.com/ to review your changes

If this link doesn't appear, please email the user or dev mailing lists.

Click on the link.

Review

The link will take you to a fully rendered version of the jclouds.incubator.apache.org site with your changes included. Review your changes to make sure everything looks the way you intended it.

A committer from jclouds will also be along to review your change. If everything looks good, they'll merge it for you. If they have some suggestions, you might have to go back and update.

Update

To update the file, you need to find it on the branch (e.g. patch-1) you initially created. For example:

https://github.com/your-user-name/jclouds-site/edit/patch-1/guides/chef.md

Go back to step 2.

Done

Congratulations. You've made a commit to Apache jclouds. Thanks!

How to Contribute Documentation (last edited 2014-05-02 19:27:26 by EverettToews)