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

Release Moodle 4.1 docs #473

Merged
merged 5 commits into from
Dec 12, 2022
Merged

Conversation

andrewnicols
Copy link
Member

@andrewnicols andrewnicols commented Dec 9, 2022

This is our first version fork.

It was generated by running:

yarn run docusaurus docs:version 4.1

There were a few minor pages to modify:

  • intro.md in both 4.1 and master docs (pointing to 4.0)
  • navbar configuration to uncomment the version dropdown

@netlify
Copy link

netlify bot commented Dec 9, 2022

Deploy Preview for moodledevdocs ready!

Name Link
🔨 Latest commit c623459
🔍 Latest deploy log https://app.netlify.com/sites/moodledevdocs/deploys/639413af616b1f00085da644
😎 Deploy Preview https://deploy-preview-473--moodledevdocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@github-actions
Copy link
Contributor

github-actions bot commented Dec 10, 2022

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO PWA Report
/ 🟠 89 🟢 95 🟢 100 🟢 90 🟢 100 Report
/docs/apis/commonfiles 🟠 62 🟢 93 🟢 100 🟢 100 🟢 100 Report
/general/development/gettingstarted 🟢 90 🟢 95 🟢 100 🟢 90 🟢 100 Report
/general/releases 🟠 82 🟢 95 🟢 100 🟢 100 🟢 100 Report

Copy link
Member

@stronk7 stronk7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi,

I've been playing a little bit with the auto-deployed version and everything seems to work ok. Using the versions drop-down is possible to switch between versioned docs (apis...) easily. So I think this PR per se is ok and can be accepted to get the first experiences with the multi-versioned docs.

Only points that I've found unnatural (or weird) are also related with the versions drop-down behaviour itself. Here there are a few points where I think that we could improve, all around that drop-down menu:

  1. Does the drop down need some label? Maybe not, but right now it looks like (to me, this is a 100% subjective feeling) it's floating in the middle of nowhere.
  2. If you hover the menu (or click on the "triangle") it correctly shows you the available options (master, 4.1 and legacy). Then can select any of them, all ok. But, if you click on the "name" of the current version, then you're redirected to the "base" document in that version. IMO, that's completely unexpected. The "name" should behave the very same than the "triangle" or become 100% disabled.
  3. Related with the above... the existence of the versions drop-down in non-versioned docs (say intro, releases, processes...) is really miss-leading (there aren't versions for those docs) and trying to switch of version (via "name" like in the previous point, or via "hover" or "triangle") leads you to the unexpected "base" page. Maybe we should hide or disable the drop-down completely in non-versioned pages?

Just those 1-2-3 strange things I found, for your consideration. As said, other than that... let's approve this now, yay!

Ciao :-)

@andrewnicols andrewnicols merged commit 17376ae into moodle:main Dec 12, 2022
@andrewnicols andrewnicols deleted the docsVersion4.1 branch December 12, 2022 04:42
@andrewnicols
Copy link
Member Author

I've raised #477, #478, #479 to look at those suggestions.

I agree with all of them. I'll try and find a good way of doing them.

@stronk7
Copy link
Member

stronk7 commented Dec 12, 2022

Cool, thanks!

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

Successfully merging this pull request may close these issues.

2 participants