tutorial.rst 835 B

123456789101112131415161718192021222324252627282930313233343536
  1. .. _tutorial:
  2. Writing a Tutorial
  3. ==================
  4. A tutorial should have a clear goal and present step-by-step instructions to achieve that goal.
  5. Example Tutorial
  6. ----------------
  7. This introductory sentence should state the intent and goal of the tutorial. Keep it brief.
  8. This next block should state any assumptions that you the writer are making. Present them in list form, for example:
  9. This tutorial assumes:
  10. * GeoServer is running on http://localhost:8080/geoserver
  11. * PostGIS is installed on the system
  12. Getting started
  13. ```````````````
  14. State any introductory steps in this section. These might include:
  15. * Downloading data
  16. * Creating a database
  17. Other sections
  18. ``````````````
  19. In a single sentence, state what will be achieved in this section. Then list
  20. the steps the user needs to take:
  21. #. Step one
  22. #. Step two