Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Move bigbluebutton-docs to the main repository #16113

Merged

Conversation

GhaziTriki
Copy link
Member

@GhaziTriki GhaziTriki commented Dec 10, 2022

Background

During BigBlueButton Developer Summit XVI held in Berlin, Germany from Nov 28 to Dec 2nd of year 2022, the community decided to rework the official documentation to make it better.

The initial work has been done in the following repository https://github.com/riadvice/bigbluebutton-docs

Contributors

This work could not be possible without the direct help of (in the contribution order):

  • @JeanPluzo: New structure of the docs.
  • @lkiesow: Multi-version build script and suggestion to merge to the main repository.
  • @danimo: Improvement the build script.

What does this PR do?

Move the official documentation with its actual content but reworked structure to the main repository.

Motivation & Context

The current documentation lacks of:

  • Clarity: only one menu and no clear scopes separation (users, dev, administration...)
    → The new documentation is now split in 6 main sections.
  • Search: No embedded search engine
    → A search engine is now included.
  • Correlation: The docs are decorrelated from the development, not everything is documented in time.
    → Documentation is now part of the main repository. Development and feature documentation should go more in parallel.
  • Multi-version: Multiple version maintenance happens on the same branch.
    → Each version is now maintained in its own branch.

Tasks

Required for merge

  • Multi-version build script
  • Move old doc pages
  • Per section menu
  • Update broken links
  • Update markdown heading title (h1, h2..) to match docusaurus requirements.

Nice-to-have

  • Github Actions configuration.
  • Create a readme about how to run docs in dev environment.
  • Custom icons, colours and layout.

To do later

  • Update Greenlight v2 and replace them with Greenlight v3
  • Merge updates from the old docs repo after commit 8cfdcde8

@sonarcloud
Copy link

sonarcloud bot commented Dec 10, 2022

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 2 Code Smells

No Coverage information No Coverage information
1.7% 1.7% Duplication

@antobinary
Copy link
Member

(Note to self/Ghazi) We'll likely need to copy over any docs changes from https://github.com/bigbluebutton/bigbluebutton.github.io/commits/master
that have taken place since ~ Nov 30, 2022

@antobinary antobinary added this to the Release 2.7 milestone Dec 15, 2022
@sonarcloud
Copy link

sonarcloud bot commented Jan 12, 2023

SonarCloud Quality Gate failed.    Quality Gate failed

Bug C 1 Bug
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 4 Code Smells

No Coverage information No Coverage information
1.7% 1.7% Duplication

@zhem0004
Copy link
Contributor

  • Why do we need "backup" folder with starter template files?
  • (allow execution on build script)
  • Teaching guide still to be done
  • Fix main page buttons in dark theme

Screenshot from 2023-01-19 14-48-45

  • Highlight of what section you are at in dark theme is very hard to see
  • "next" buttons on bottom of pages run you in circles

@antobinary
Copy link
Member

Just talking with @danimo @schrd @tibroc and others and the consensus is that the work in this PR is a huge leap forward in a desired direction. BIG Thanks to @GhaziTriki @JeanPluzo @lkiesow @danimo and anyone else who has contributed.

Merging this will allow others to contribute more easily even while this docs version is being built.

@antobinary antobinary marked this pull request as ready for review February 6, 2023 15:11
@antobinary antobinary changed the base branch from develop to v2.6.x-release February 6, 2023 15:11
@antobinary antobinary changed the title Merge bigbluebutton-docs to the main repository docs: Move bigbluebutton-docs to the main repository Feb 6, 2023
@antobinary antobinary merged commit 2afb143 into bigbluebutton:v2.6.x-release Feb 6, 2023
@danimo danimo mentioned this pull request Feb 6, 2023
@antobinary antobinary modified the milestones: Release 2.7, Release 2.6 Feb 17, 2023
@GhaziTriki GhaziTriki deleted the docs-resource-center branch March 5, 2023 20:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants