project-sunbird/project-sunbird.github.io

Documentation on how to use the Sunbird, an open, collaborative platform for 21st century digital education

Sunbird Documentation Repository

What is Sunbird?

Sunbird is a next-generation scalable open-source learning solution for teachers and tutors. Built for the 21st century with state-of-the-art technology, Sunbird runs natively in cloud/mobile environments. The open-source governance of Sunbird allows a massive community of nation-builders to co-create and extend the solution in novel ways.

What is the project mission?

Project Sunbird has a mission to improve learning outcomes for 200 million children across India. This is a multi-dimensional problem unique to the multi-lingual offline population of India (and other developing countries). It's not a problem of any single organization or stakeholder and it cannot be realistically addressed by individual effort.

Project Sunbird is a multi-year, multi-stakeholder open, iterative and collaborative approach to bring together the best minds in pursuit of this audacious goal.

Getting Started

To get started with Sunbird, please try out our demo site at: https://demo.open-sunbird.org/

Reporting Issues

We have an open and active issue tracker. Please report any issues or you find.

project-sunbird.github.io's Issues

Add FAQ Section and Update API's

Documentation site must support multiple versions of the documentations

The documentation site must allow visitors to reference documentation for past versions of the platform.

Each "href" to external link needs to be opened in new tab

@nawabahmadreshi commented on Fri Oct 13 2017

We need to enable opening of external links in a new tab for richer user experience .
@lakhanmandloi
cc:
@Sunitashelar

---

@nawabahmadreshi commented on Mon Oct 16 2017

@kochhar
Opening external links in the same tab, creates back-button fatigue for users. Every time the user goes to an external website they have to hit the back button to go back to your website. If they decide to click the links on the other website, they have to hit the back button even more times to get back to the site.
Also opening the external links in new tabs allows users to scan the page once, click on all the relevant links and start consuming information. The user doesn’t have to keep going back to the source page to continue scanning for more links to click. There’s less interruption in their user flow, thus richer user experience.
Opening external links in the same tab doesn’t just overwork the user, it also overworks the website. Every time the user goes back to the website it uses site resources to load the page.
cc:
@Sunitashelar

---

@lakhanmandloi commented on Thu Oct 26 2017

@nawabahmadreshi yes , i agree. External links should be opened in new tabs. Can you pls mention where we need such ? we will correct them .

Developer Install docs code blocks are broken

@kochhar commented on Fri Oct 27 2017

@nawabahmadreshi Please see this page: http://www.sunbird.org/developer-docs/developer_install/

Bottom part of the page:
Edit the application config:

The code block formatting is broken. The code should be formatted as a block and not as inline code. When formatting it as a block one config entry should appear on every line.
http://www.sunbird.org/developer-docs/developer_install/

---

@nawabahmadreshi commented on Fri Oct 27 2017

@kochhar, agreed and will do the necessary changes.

---

@kochhar commented on Thu Nov 02 2017

@nawabahmadreshi could you estimate when will this be completed? Formatting is still broken on the website for multiple sections.

cc: @Sunitashelar

Contribution guidelines needs steps to preview build results from pull request

The current contribution guidelines needs to contain the steps required to preview the build results of a pull request

https://github.com/project-sunbird/project-sunbird.github.io/blob/dev/pages/contributions/contribution_guidelines.md

@Sunitashelar I think @lakhanmandloi should create a fork, update the guidelines and submit a pull-request to test out the process. what do you think?

Some mechanism for 404 page and 302 redirects.

Test issue

This is a text issue "Ref. contribution"

Installation guides should list OS prerequisites for installation

@kochhar commented on Fri Nov 03 2017

The laptop installation guide is missing the information that install needs to be done on a linux OS.
Windows installation instructions should be provided as a separate section.

The same should be applied for the medium sized installation guide. Some parts of the application may not run on windows. The appropriate sections must be updated to indicate this.

Sunbird installation instructions should have new installers request a QA API key initially

@kochhar commented on Thu Nov 09 2017

Installation instructions instruct users to generate an API token from production EkStep. The instructions should instruct users to generate API tokes from EkStep QA: https://github.com/project-sunbird/sunbird-commons/wiki/Obtaining-API-token-for-accessing-ekstep-APIs

---

@kochhar commented on Thu Nov 09 2017

@coolbung also as part of this change please move the instructions for generating an API key to the Sunbird documentation site. Ideally, we should reference the EkStep instructions so that we do not fall behind or get out of sync.

Missing mobile app documentation

Documentation is missing for sunbird mobile app build.

documentation for docs building

@lakhanmandloi could you please add a README file to this repo which explains how to create a new docs dev build and a new docs prod build

Website doesnot render correctly on mobile

When browsing the website on mobile, the following problems were noted:

• Tables are rendered completely. The whole table is not visible.
• Cannot scroll vertically to view the entire table
• Cannot expand the screen
• The burger menu is clickable only once. It does not respong to subsequent clicks

Need for a FAQ doc creation

@manzarul Please take care of the content for the Sunbird FAQ doc. Find the link below:
https://github.com/project-sunbird/project-sunbird.github.io/blob/dev/pages/developer-docs/sunbird_faq.md

Please update the same in the issue tracker sheet as well.

Push live generated site

Add search functionality

"Provisioning servers" (Manual process) steps are missing

Referencing to this medium scale installation doc. ,
https://github.com/project-sunbird/sunbird-devops/blob/master/Installation.md#manual
The manual steps are probably missing .
Providing you the link to an empty .md file where you can put in all the necessary information.
The link to the file is here :
https://github.com/project-sunbird/project-sunbird.github.io/edit/dev/pages/developer-docs/installation/provisioning-servers.md

cc:
@Sunitashelar

Resource Bundles Documentation

Create document for Sunbird-portal resource bundles.

Keycloak_sms_authenticator documentation

https://github.com/project-sunbird/project-sunbird.github.io/blob/dev/pages/developer-docs/resource/Keycloak_sms_authenticator.md

Kindly add the information in this blank .md file provided as a link above

Developer documentation should have links back to source

@kochhar commented on Fri Nov 03 2017

Developer documentation is incomplete and sometimes gets out of date. When external users find errors in the docs, they must be able to edit and fix the errors. Each doc must have a link back to its source file, plus links to documentation for how to submit docs corrections.

Document creation will become more collaborative.

cc: @Sunitashelar, @nawabahmadreshi

---

@kochhar commented on Fri Nov 03 2017

cc: @lakhanmandloi

Deployment Process Documentation

Deployment process documentation needs to be prepared for Docs team.
Needs to have -

• Procedures to deploy on QA and Live

• Limitation of current methods and future enhancements points

• Debugging steps for common issues

Need elevated access for this repo. (CircleCI Integration)

Hi @coolbung , @madhucr , @kochhar , @parthlawate and @harshithaks

I need elevated access for this repo - https://github.com/project-sunbird/project-sunbird.github.io
in order to complete tasks of #13.

docs deployment should build staging versions for pull requests

when new pull requests are sent to the docs site, the CI should automatically build a new site version and make it available for inspection

Collapsible Sidebar + Cache Issue and Other Updates

GA not working

Contribution Section for Sunbird Website

@nawabahmadreshi commented on Mon Oct 09 2017

Hello Team,
We need to put up the contribution section for sunbird website .
Put comments and suggestions if any.
cc:
@Sunitashelar
@kochhar
@deepshikha2k5
@Basreena
@vrayulu

---

@nawabahmadreshi commented on Mon Oct 09 2017

@kochhar , kindly suggest the point of contact for contribution section .
Also once you had said that we have some wiki or some doc related to it , can you provide the link .

Fix outdated Sunbird v1.0 installation documentation

Epic to track the fixes required in Sunbird 1.0 installation documentation which has drifted out of date with the codebase.

Installation guides should checkout specific Sunbird releases

@kochhar commented on Fri Nov 03 2017

Installation guides do not point to a specific release of Sunbird. Thus the instructions can be out of date if the code base changes.

The guides must be updated to provide instructions for a specific release of Sunbird. The instructions should indicate how to get the code for a specific stable version.

Update Installation Overview Links in sunbird-portal repo

Hi @kochhar @vrayulu ,

Can you please update links in Sunbird-Portal Repo details (https://github.com/project-sunbird/sunbird-portal) from http://www.sunbird.org/developer-docs/installation_overview/ to http://www.sunbird.org/developer-docs/installation/

First one is old link and later one is updated link.

@nawabahmadreshi can you please delete source of http://www.sunbird.org/developer-docs/installation_overview/ after verifying the latest content is already available in http://www.sunbird.org/developer-docs/installation/

Thanks!

Documentation for local proxy

Create a document for sunbird portal to connect local proxy.

Tables without division doesnot render correctly

Tables without division renders differently in different systems. On some sytems the entire table is visible or others only half the table is visible.

Keycloak realm config

The realm configuration page is missing is the sunbird installation docs. Can you please add

Here's the link to the wiki - https://github.com/project-sunbird/sunbird-commons/wiki/Keycloak-realm-configuration

test

test

Some mechanism for Automated Spelling check and MD linting

Scroll to Top Button

Structure

Installation documentation needs section on accessing Telemetry data

See source issue filed: https://github.com/project-sunbird/sunbird-commons/issues/112

Questions asked:

1. What are the APIs used to access telemetry?
2. What are the telemetry datasets available?
3. What kind of permissions are required to access the dataset?

About Pages changes

Sunbird - CircleCI Integration Prod Deployment

Reference Link - https://github.com/project-sunbird/sunbird-commons/issues/73

Following tasks needs to be done -

• Git - Commit Dockerfile to Devops Repo

• Git - move codebase to project-sunbird.github.io dev branch

• Git - Protect master branch - restrict commits to few peoples

• CircleCI - Link repo and add ssh key for repo access

• CircleCI - User SSH Key Addition with write access for prod deployment

• S3 - Change Bucket, Use bucket from sunbird account.

• Docker - Build & Host Docker image on sunbird account

test2

hi

Machine user for automated deployments and comments

Sequential number rendered incorrectly

When providing sequential instructions in github, the numbering appears sequentailly correct but on the website it is rendered incorrectly. While on github it si 1,2,3, it gets rendered as 1,1,1 on the website.

Build Promotions should take same commit reference for dev and prod tags.

While Prod tag is created. Meanwhile if someone has committed some changes in between dev tag creation and prod tag creation. Prod tag takes reference to the latest commit. Even editing dev tag creates reference to the latest commit.

Although this is not creating any trouble. But prod tag confuses user to the wrong references.

FYI - Prod tags are used for triggering production deployment and has nothing to do with code base. It just takes the S3 Bucket site and commits to GH Pages.

This diff commit references needs to fixed by either manual approval method of CircleCI OR Something else.

FYI - Hold / Manual Approval method was tried but didn't worked. Need to figure out why it didn't worked.

cc:
@kochhar @parthlawate @coolbung

Table of Content for each Documentation page

Documentation issue- Install Sunbird on Laptop

In the documentation under Install Sunbird on laptop the "Edit Application Config"
For the parameter module.exports it is not understandable as to what should be modified since there are continuation punctuation consisting of dots.

In the original file the entire parameter- module.exports is not present

Requirement to include links within images

Require a clickable area within an image, to include links to other pages or topics in the image.

Add CNAME File to point sunbird.org

Wiki links to sunbird-commons and sunbird-devops must be deprecated

@kochhar commented on Thu Nov 09 2017

The present installation instructions reference wiki pages inside sunbird repositories. These references should be moved to the sunbird documentation portal.

@project-sunbird/techwriters please suggest an appropriate section (possibly new) of the sunbird documentation hub which can house the following wiki links:

1. https://github.com/project-sunbird/sunbird-devops/wiki/Updating-SSL-certificates-in-Sunbird-Proxy-service
2. https://github.com/project-sunbird/sunbird-devops/wiki/Generating-a-self-signed-certificate
3. https://github.com/project-sunbird/sunbird-commons/wiki/Obtaining-API-token-for-accessing-ekstep-APIs
4. https://github.com/project-sunbird/sunbird-commons/wiki/Keycloak-realm-configuration
5. https://github.com/project-sunbird/sunbird-commons/wiki/Deploying-Custom-html-pages-and-images

cc: @endeepak, @Manojvv @vrayulu

Difference when providing hyperlink reference

When providing hyperlink reference for image, the path takes the folder name and image name. However when providing hyperlink for pages, the link starts with the pages to folder to file name. Please rectify. For consitency, the path taken should be same. Either both the path for image and pages takes only folder name and image name or the link starts with pages to file name. In either case, it should be same for both.

Outdated Sunbird installation documentation

@kochhar commented on Fri Nov 03 2017

Tracking Work progress (Creating your own genie app)

Currently working on documentation of Creating your own genie app
Start date 17/1/2017