Skip to content

Latest commit

 

History

History
48 lines (30 loc) · 3.14 KB

how_to_use_book.md

File metadata and controls

48 lines (30 loc) · 3.14 KB
Raw

The PEcAn Gitbook

This book serves as documentation for the PEcAn Project. It contains descriptions of topics necessary to inform a beginner and advanced user as well as requisite materials for developers. It does not contain low-level descriptions of functions within PEcAn. Our aim for this documentation is to educate you about the PEcAn software, the possibilities of its usage, and the standards,expectations, and core workflows for developers.

How to Contribute

If you wish to contribute to this book, we greatly welcome it! The same general steps to contributing PEcAn code to the main line can be used to contribute to this book.

For large edits

  1. Navigate to the book's github repository: https://github.com/PecanProject/pecan.book and fork the repository to your github account.

  2. Use git clone on the machine your are using to create a local copy of the repository. General instructions can be found here

  3. Edit/add your content to the book using any text editor. Save your files in the markdown format (.md).

  • If you are adding a new page, you must edit the SUMMARY.md file also and list your page in order for it to be properly indexed by gitbook.

  1. Commit git commit -m "your message" your changes and push git push them to your fork.

  2. Create a pull request, using github, with a description of the changes you have made.

For minor edits

  1. Move your cursor next to the paragraph you would like to suggest changes and press the + button.

  2. Leave a comment with your changes and we will see to it that those changes are made.

###Feedback/Comments/Suggestions We want your ideas, thoughts, comments, and suggestions! This is an open-sourced project so please feel free to reach out to us in the following ways:

Github: https://github.com/PecanProject/pecan Serving as the main hub of communication surrounding PEcAn development, check out the issues section to see what is coming down the pipeline. If there is anything you feel you can contribute to, leave a comment.

Gitter: http://pecanproject.github.io Gitter serves as our day to day mode of communication. Go to our homepage, linked above, and open the "OPEN CHAT" tab at the bottom to see what we are up to. All you need is a github account and you can chat with us about anything project related.

Gitbook: https://pecan.gitbooks.io/pecan-documentation/content/ As stated above, this is a book with all of the documentation for the PEcAn Project. If you use the gitbook interface, next to each paragraph there is a "+" that will allow you to start a discussion. Please use this utility to ask for clarification about any documentation or direct any question/comment to the team.

Email: pecanproj[at]gmail.com If you do not wish your communication with the team to be public, send us an email at the address above and we will get back to you as soon as possible.