Skip to content
This repository has been archived by the owner on Apr 29, 2024. It is now read-only.

test: two courses in one site #60

Closed
wants to merge 12 commits into from
Closed

test: two courses in one site #60

wants to merge 12 commits into from

Conversation

adiati98
Copy link
Member

Description

This PR is to show the test of combining two courses in one site, and not meant to be merged.


With this combination, to be able to run the project properly, we should:

  • put all files and folders that are needed to be rendered in the "docs" file,
  • have README, CONTRIBUTING, i18n translation, in each course folder. The README will serve as the course landing page as what we have now,
  • move _navbar and _sidebar out from _layout folder and put them in their own course file. This is necessary, otherwise, both navbar and sidebar won't be rendered properly.
  • change the paths of internal links.

I played around as well with below things:

  • Created a _coverpage.md. Cover page can serve as homepage if we don't want to create a dedicated homepage. It can only hold minimal text. If we opt for this, we might as well need to find a way to hide the navbar.

  • The current color in our intro to oss website is not accessible. So, I played around with the color scheme and use most of OpenSauced brand that I took from OpenSauced landing page repo, as well as the font type. It's not 100% accessible, but it's much better than what we have.

  • Added docsify-pagination plugin to navigate to previous or next chapter. I think this plugin is much better that what we currently have (shown in the green box), and the repo is quite active (last PR merged was 4 months ago).

    Screenshot 2024-02-25 194218

What type of PR is this? (check all applicable)

  • 🍕 Feature
  • 🐛 Bug Fix
  • 📝 Documentation Update
  • 🎨 Style
  • 🧑‍💻 Code Refactor
  • 🔥 Performance Improvements
  • ✅ Test
  • 🤖 Build
  • 🔁 CI
  • 📦 Chore (Release)
  • ⏩ Revert

Related Tickets & Documents

Mobile & Desktop Screenshots/Recordings

test opensauced courses

Steps to QA

  1. Pull this branch.
  2. Run npm i docsify-cli -g to install the dependency.
  3. Run docsify serve docs.
  4. By default, once the app run, you will see a homepage. If you want to try the cover page:
    • Go to docs\index.html.
    • Uncomment line 31 & 32.

Added to documentation?

  • 📜 README.md
  • 📓 docs.opensauced.pizza
  • 🍕 dev.to/opensauced
  • 📕 storybook
  • 🙅 no documentation needed

[optional] Are there any post-deployment tasks we need to perform?

[optional] What gif best describes this PR or how it makes you feel?

@adiati98
Copy link
Member Author

@BekahHW @jdwilkin4

I've played around with combining two courses into one site. And I created this PR if you want to try it out.
Please let me know if it doesn't work or anything because I reverted some carried over commits, which I hope won't affect the result. 😅

Thanks!

@BekahHW
Copy link
Member

BekahHW commented Mar 6, 2024

This is great, @adiati98. Thank you!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants