Skip to content

Template

Overview

This tutorial template shows the basic format of a tutorial. Its purpose is not to restrict but to show the basic structure of a document. The overview section should have short explanation about what this tutorial is about and what reader can expect from it.

Prerequisites

The prerequisities section tells what is needed before this tutorial can be completed. It should not state the steps in this tutorial but preferrably to link to other tutorials.

To make page invisible in search, you can add the page path to "plugins -> exclude-search -> exclude" section in mkdocs.yaml. This file is for example hidden from search and can't be found if the user does not know the url as it is not included in the navigation either.

Try to also use pictures and links to third party resources where applicable. If your tutorial uses some Giosg HTTP API for example, link to that API's description in API reference.

You can also use following syntax to highlight some important parts on your tutorial:

Notice

This a note that reader should pay attention to something

Or you can use following syntax to warn about something in tutorial:

Warning

This is warning and user should really take this into consideration!

Step 1

What is done and why. All the steps should include copy-pasteable code blocks so that:

  • First step code block works independently
  • Other steps' code blocks work if previous steps' code is executed in order
  • Always try to provide code examples on both Python and JavaScript if applicable.
1
2
# It is ok to have comments
some_variable = "Hello Python!"

1
2
// It is ok to have comments
some_variable = "Hello Javascript!"

Notice

It is important that you test the example code after writing it to make sure that it works!!

Step 2

This is the second step and it is ok to refer to the first step.

1
print(some_variable)

1
console.log(some_variable)

Step X

This is the final step - the culmination point of it all.

1
del some_variable

1
delete some_variable

After finalising the tutorial, remember to update the Changelog with link to new tutorial.

Conclusion

In this tutorial we showed the basic structure for a tutorial. We learned the different sections and what they are used for. For more information please refer to these non-existing documents. The conclusion part also include all the code snippets in a single code block. We hope you enjoyed!

1
2
3
4
5
6
# It is ok to have comments
some_variable = "Hello Python!"

print(some_variable)

del some_variable

1
2
3
4
5
6
// It is ok to have comments
some_variable = "Hello Javascript!"

console.log(some_variable)

delete some_variable

What's next?

It is a good practice to direct the reader to next tutorial, it might be more advance continuation of current tutorial or some other related or frequently requested thing.

This section could describe what other things the user could do with Giosg platform.

Endpoins used in this tutorial

Links to the API endpoint documentation used in this tutorial.

https://docs.giosg.com/api_reference/giosg_live/giosg_http_api/chats/#list-chats-at-a-room