UbuCon Asia team has its own documentation on docs.ubucon.asia. and its contents are sourced from Ubuntu Discourse. This documentation describes how you can create new one and add that on docs.ubucon.asia.
Create document on Ubuntu Discourse
First thing to do is creating new document on Ubuntu Discourse. For UbuCon Asia Documentation please create discourse topic on Documentation > Event category. Also, make sure to set ubucon-asia and ubucon tags so that it can be distinguished from other event documentations.
Adding document to docs.ubucon.asia
UbuCon Asia Docs website is hosted on GitHub Pages. You may fork website GitHub repo then edit navigation.ts file to add new document to the website.
This is how navigation.ts looks like. You will be editing navigation array to add new page on the website.
export const discourseHost = "https://discourse.ubuntu.com/"
export const navigation = [
{
title: "Home",
slug: "/",
discourseUrl: "t/ubucon-asia-documentation/47858",
subsection: [ ]
}
...
]
To add page on top level, simply add new item like this. where title is text that will be shown on navigation, slug for path on website and discourseUrl for the discourse post url without website domain.
export const discourseHost = "https://discourse.ubuntu.com/"
export const navigation = [
{
title: "Home",
slug: "/",
discourseUrl: "t/ubucon-asia-documentation/47858",
subsection: [ ]
},
{
title: "New page",
slug: "/",
discourseUrl: "t/new-page/47858",
subsection: [ ]
},
...
]
If you would like to add page under subsection, you may add item in subsection property like this. up to 4 depth is possible. When adding on subsection, make sure that slug has path that follows parent page. For example, if you are adding Travel grant (travel-grant) under Travel support (/travel-support) make sure to set slug as /travel-support/travel-grant so that page will be published properly and website navigation will be also displayed properly.
export const discourseHost = "https://discourse.ubuntu.com/"
export const navigation = [
{
title: "Depth 1",
slug: "/",
discourseUrl: "t/ubucon-asia-documentation/47858",
subsection: [
{
title: "Depth 2",
slug: "/depth2",
discourseUrl: "t/ubucon-asia-chat-information/47859",
subsection: [
{
title: "Depth 3",
slug: "/depth2/depth3",
discourseUrl: "t/ubucon-asia-chat-information/47859",
subsection: [
{
title: "Depth 4",
slug: "/depth2/depth3/depth4",
discourseUrl: "t/loco-handover-process/46760/5"
},
]
},
]
}
]
}
]
Submitting pull request
Once you done with editing navigation.ts please open pull request by clicking here. UbuCon Asia Committee will have a look and merge if all looks good.