User story
As a user
I want Gibbon's documentation to be better structured
So that I can more easily find information to learn how to use Gibbon
Acceptance criteria
Given I am on https://docs.gibbonedu.org/
When I look at the home page for Gibbon documentation
Then I can see a box with a link to the Get Started section
And I can see a box with a link to the Tutorials section
And I can see a box with a link to the How-To Guides section
And I can see a box with a link to the Explanation section
And I can see a box with a link to the Reference section
And I can see a box with a link to the Community Support section
And I do not see a button with an Introduction link
And I do not see a button with a Installing Gibbon link
And I do not see a button with a Getting Started link
And I do not see a box with an Open Source link
And I do not see a box with a Gibbon Road Map link
And I do not see a box with a Start Developing link
Additional information
Based on last week's documentation meeting, we discussed using Diataxis to create a documentation structure that allows users to make better use of the documentation. This means all of Gibbon's current documentation will be relocated into one of four sections: tutorials, how-to guides, reference and explanation - see spreadsheet.
In addition, there will be a Get Started section to provide an entry point for new Gibbon users. This section will introduce Gibbon and provide separate sets of links to information contained in the tutorials, how-to guides, and reference which will guide different types of new users, e.g. a student, teacher, parent, system administrator, developer, to do what they need to do in Gibbon.
There will also be a Community Support section which will contain links to information on how to obtain support for using Gibbon.
Mock up for home page:
The current Gibbon documentation structure looks like this:
The new Gibbon documentation structure will aim to look like this in the future:
N.B. This issue is an epic. Work needs to be done on smaller tickets before this ticket can be done.
User story
As a user
I want Gibbon's documentation to be better structured
So that I can more easily find information to learn how to use Gibbon
Acceptance criteria
Given I am on https://docs.gibbonedu.org/
When I look at the home page for Gibbon documentation
Then I can see a box with a link to the Get Started section
And I can see a box with a link to the Tutorials section
And I can see a box with a link to the How-To Guides section
And I can see a box with a link to the Explanation section
And I can see a box with a link to the Reference section
And I can see a box with a link to the Community Support section
And I do not see a button with an Introduction link
And I do not see a button with a Installing Gibbon link
And I do not see a button with a Getting Started link
And I do not see a box with an Open Source link
And I do not see a box with a Gibbon Road Map link
And I do not see a box with a Start Developing link
Additional information
Based on last week's documentation meeting, we discussed using Diataxis to create a documentation structure that allows users to make better use of the documentation. This means all of Gibbon's current documentation will be relocated into one of four sections: tutorials, how-to guides, reference and explanation - see spreadsheet.
In addition, there will be a Get Started section to provide an entry point for new Gibbon users. This section will introduce Gibbon and provide separate sets of links to information contained in the tutorials, how-to guides, and reference which will guide different types of new users, e.g. a student, teacher, parent, system administrator, developer, to do what they need to do in Gibbon.
There will also be a Community Support section which will contain links to information on how to obtain support for using Gibbon.
Mock up for home page:
The current Gibbon documentation structure looks like this:
The new Gibbon documentation structure will aim to look like this in the future:
N.B. This issue is an epic. Work needs to be done on smaller tickets before this ticket can be done.