You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jclouds.apache.org by Apache Wiki <wi...@apache.org> on 2014/05/02 21:28:57 UTC

[Jclouds Wiki] Update of "How to Contribute Documentation" by EverettToews

Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Jclouds Wiki" for change notification.

The "How to Contribute Documentation" page has been changed by EverettToews:
https://wiki.apache.org/jclouds/How%20to%20Contribute%20Documentation?action=diff&rev1=7&rev2=8

- 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.
  
  <<TableOfContents(3)>>
  
  == Find ==
  
+ 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. 
- 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]] ||
  
  == Change ==
  
  === Edit a Page ===
  
- 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.
+ 1. 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.
  
  === Guest Blog Post ===
  
@@ -35, +20 @@

  
  {{http://i.imgur.com/JJpVb5W.png}}
  
- 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]]).
  
  3. To get a quick start on your post you might want to copy the raw text from an existing post (e.g. [[https://raw.githubusercontent.com/jclouds/jclouds-site/master/_posts/2014-03-04-jclouds-meetup.md|2014-03-04-jclouds-meetup.md]]) into the editor in your web browser and change the text.
  
@@ -49, +34 @@

  
  == 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 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]].
  
  Eventually you should see a comment that reads.