Add feature: collapsible sidebar

[uday-rana]

I'd like to make the sidebar collapsible, like in Intro2OOP.

This would require a simple edit of docusaurus.config.js to add the following lines:

  themeConfig: {
    docs: {
      sidebar: {
        hideable: true,
      },
    },

similar to Seneca-ICTOER/Intro2OOP/commit/337ae7.

[uday-rana]

@humphd I'd appreciate it if you could look at this issue and let me know if this is a feature you're open to adding, and if you are, I'd like to go ahead and work on it. I'd also like to add this to Seneca-ICTOER/AdvOOP and Seneca-ICTOER/OERTemplate. Thanks!

[humphd]

cc @CameronGray1210 @catherine-leung

[CameronGray1210]

Yes I can see the advantage of having the collapse feature.

cc @humphd @catherine-leung @uday-rana

[catherine-leung]

I would like this to be added to the template instead of the ipc notes. The template will affect all new course notes. The IPC notes are being replaced as part of our course update in the near future

https://github.com/Seneca-ICTOER/OERTemplate

[cszalwinski]

Please be careful not to inadvertently seed surprises or conflicts down the road. David asked me to raise issues regarding OERTemplate if they arise. See conversation #180. #180 The material I provided Seneca brought with it a minimum of responsibility, but some nevertheless. Care needs to be exercised diligently regarding licensing. The template stipulates a different license. Adopting this template may create the conditions for copyright infringement. If any content present in the course notes released under copyright Chris Szalwinski and Seneca College CC BY 2.5 is or will be incorporated in derivative works, the copyright notice and license must be retained and displayed with that content in a prominent place on all derivative sites. Using the license present in OERTemplate and the copyright notice in docusaurus.config.js would automatically divest Seneca of its share of the copyright in the copied content and trigger a compulsory takedown of each infected page or site. Chris

…

On Fri, Oct 18, 2024 at 2:03 PM Catherine Leung ***@***.***> wrote: I would like this to be added to the template instead of the ipc notes. The template will affect all new course notes. The IPC notes are being replaced as part of our course update in the near future https://github.com/Seneca-ICTOER/OERTemplate — Reply to this email directly, view it on GitHub <#182 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAU2ZROSVA2LDEZJDAGHZ2TZ4FEQ3AVCNFSM6AAAAABQELTCSCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDIMRSHE4DCMBSGE> . You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

[catherine-leung]

Hi Chris

Sorry about this, but I'm trying to understand what the issue here is with the template.
The template does not have content specific to any course notes. It is typically used only to create new course notes. I tried to make sure I did not include any content specific to any courses in the template. I'm wondering if I missed something when I created it. If I did, I am happy to remove it from the template as it should not be there. The images/texts/examples comes from docusaurus and things I made to show how to use the template.

Any updates to the 3 course notes that you wrote should have your name. On that I fully agree with you. I fully understand this and have reverted any changes that caused its removal.

[cszalwinski]

Hi Cathy, Thanks for confirming and reverting the changes. The history led me to believe the doc...config.js file for Intro2OOP might have been overwritten by the OERTemplate version, then reverted to the corrected version, then reverted back to the previous. If that's what happened, it could happen again by accident. Do you think adding something wild like all caps and stars with some notification to line 46 of the OERTemplate would draw attention that would force a manual intervention? Just a thought. Cheers, Chris

…

On Fri, Oct 18, 2024 at 3:45 PM Catherine Leung ***@***.***> wrote: Hi Chris Sorry about this, but I'm trying to understand what the issue here is with the template. The template does not have content specific to any course notes. It is typically used only to create new course notes. I tried to make sure I did not include any content specific to any courses in the template. I'm wondering if I missed something when I created it. If I did, I am happy to remove it from the template as it should not be there. The images/texts/examples comes from docusaurus and things I made to show how to use the template. Any updates to the 3 course notes that you wrote should have your name. On that I fully agree with you. I fully understand this and have reverted any changes that caused its removal. — Reply to this email directly, view it on GitHub <#182 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAU2ZRMVI57CAV2WGU3TOKLZ4FQORAVCNFSM6AAAAABQELTCSCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDIMRTGEZDQMZQGU> . You are receiving this because you commented.Message ID: ***@***.***>

[catherine-leung]

Hi Chris, sorry I'm still not sure I understand...

I am not sure why your name wasn't in the oop file (sorry I rarely ever look at notes in production since I don't teach those courses) so didn't even know it was missing. I have reverted it to ensure credit is given. That is only fair.

The OERTemplate does not affect any previously created OER's. It doesn't even affect OER's created based entirely on the template.

Github has 2 means of creating repos based on existing repos. One is to fork a repo. When you create a repo from a fork, then changes to the original can be pushed into repos based on original.

However, the template repo is based on a different means of creating repos called a template. If a repo is created from a template, changes to the template cannot be automatically merged into anything created from that template. The OERTemplate (and its recommended usage) is as a template, not as a fork.

Your 3 sets of notes were not created out of the OERTemplate.

I made that template because I needed an easy way to spin up new notes as I was moving my notes out of gitbooks. the template should not have affected any of the existing notes in the repos. I did however add some features while making the template (such as notes on how to put things in, simplification of some of the build processes, math support and so on). Perhaps there was an attempt at manually adding some of these features (or other features) into the 3 sets of node that created the issue.

I think the place where this would need to be added isn't in the template.. it should be added to the 3 sets of course notes. Perhaps a loud addition of comments just above the line so that any review of the diffs will show capture what must be kept? (Not sure how comments would work in that particular file... this would need to be tested).

[cszalwinski]

Hi Cathy, Not to worry. I think I understand the process. David entered (c) Seneca College in Intro2c on Oct 7, 2021. Cameron copied the Intro2c files to Intro2OOP on Feb 27, 2022 (c) Seneca College (initial commit). David corrected Intro2OOP to (c) Chris Szalwinski and Seneca College on Dec 3, 2022. Uday-R changed back to (c) Seneca College in Intro2OOP on Aug 8, 2023. Uday-R restored back to (c) Chris Szalwinski and Seneca College on Aug 8, 2023. Fardad reverted back to (c) Seneca College on Dec 22, 2023. You reverted back to (c) Chris Szalwinski and Seneca College on Oct 18, 2023. Your suggestion of a loud addition of comments makes sense to me. Cheers, Chris

…

On Fri, Oct 18, 2024 at 5:42 PM Catherine Leung ***@***.***> wrote: Hi Chris, sorry I'm still not sure I understand... I am not sure why your name wasn't in the oop file (sorry I rarely ever look at notes in production since I don't teach those courses) so didn't even know it was missing. I have reverted it to ensure credit is given. That is only fair. The OERTemplate does not affect any previously created OER's. It doesn't affect OER's created based entirely on the template. Github has 2 means of creating repos based on existing repos. One is to fork a repo. When you create a repo from a fork, then changes to the original can be pushed into repos based on original. However, the template repo is based on a different means of creating repos called a template. If a repo is created from a template, changes to the template cannot be automatically merged into anything created from that template. The OERTemplate (and its recommended usage) is as a template, not as a fork. Your 3 sets of notes were not created out of the OERTemplate. I made that template because I needed an easy way to spin up new notes as I was moving my notes out of gitbooks. the template should not have affected any of the existing notes in the repos. I did however add some features while making the template (such as notes on how to put things in, simplification of some of the build processes and so on). Perhaps there was an attempt at adding some of these features made that happen. I think the place where this would need to be added isn't in the template.. it should be added to the 3 sets of course notes. Perhaps a loud addition of comments just above the line so that any review of the diffs will show capture what must be kept? (Not sure how comments would work in that particular file... would need to be tested). — Reply to this email directly, view it on GitHub <#182 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAU2ZROI7BGFKQRFB35YI33Z4F6E5AVCNFSM6AAAAABQELTCSCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDIMRTGI3TCNZVHE> . You are receiving this because you commented.Message ID: ***@***.***>

[catherine-leung]

Thinking on this.. perhaps the better solution and one that would lead to less issue is the creation of a clear Authors page. That author's page is part of the content system (so it exists in the docs folder)

The docusaurus.js page is often updated to get newer versions of addons and so on (I think.. or I might be confusing it with other files...)

How do you feel about adding that page? I would suggest the creation of a Cover page to our notes which include Title and authors. Authors should be generated from an Authors.md file. This would take it out of the js file so that it doesn't get accidentally overwritten. It would also be useful to have if we were to add automatic pdf generation also.

[cszalwinski]

Adding an Authors page makes sense to me. I had a cover page when we printed textbooks. A link to the CC-BY 2.5 would help completeness. Are Author pages standard protocol?

…

On Fri, Oct 18, 2024 at 6:44 PM Catherine Leung ***@***.***> wrote: Thinking on this.. perhaps the better solution and one that would lead to less issue is the creation of a clear Authors page. That author's page is part of the content system (so it exists in the docs folder) The docusaurus.js page is often updated to get newer versions of addons and so on (I think.. or I might be confusing it with other files...) How do you feel about adding that page? I would suggest the creation of a Cover page to our notes which include Title and authors. Authors should be generated from an Authors.md file. This would take it out of the js file so that it doesn't get accidentally overwritten. It would also be useful to have if we were to add automatic pdf generation also. — Reply to this email directly, view it on GitHub <#182 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAU2ZRNPZ4FPOWULQNCKYYLZ4GFL5AVCNFSM6AAAAABQELTCSCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDIMRTGMZTKNRZGA> . You are receiving this because you commented.Message ID: ***@***.***>

[catherine-leung]

I'm not sure.. this is something that I will need to look at... It wasn't in the template repo I was working from... this is their own usage:

https://docusaurus.io/docs

and as you can see, it does not look like there is the concept of a cover or author page.
I'm not sure if this is part of the framework.. There is a blog plug in about adding authors but I don't think that is what we want.

The simplest thing to do is to create a cover page and hard code the authors into it and for established notes that might be the easiest thing to do...

A more long term solution would be to add an authors.md file that gets picked up and used to generate the cover.. for the template but that would still need to be manually added to your notes as they are not affected by template changes.