search

openprivacytech / openprivacytech.org

Welcome to our official website
https://openprivacytech.org
Apache License 2.0
15 stars 19 forks source link

Create sidebar for Resources #3

Closed souravcipher closed 2 years ago

souravcipher commented 2 years ago

The resources page should have a sidebar for Federated Learning, Differential Privacy, etc.

Please check the Documentation first and leave a comment here if you're interested in contributing.

Swetha-kodam commented 2 years ago

Hello... I'm interested in working on this sidebar

souravcipher commented 2 years ago

Hi @Swetha-kodam, sure - we are using docusaurus to build this website.

Please check out the documentation and feel free to submit a PR. Here's an example for the sidebar Getting-Started-Docusaurus.webm

Swetha-kodam commented 2 years ago

Hello @souravcipher ,so I'm going through the docusaurus and about sidebar so can i know first what are the items we need to be aligned in the sidebar and also the sub domain items.

souravcipher commented 2 years ago

Yeah - you have to create a sidebar for Resources and create categories for each topic like FL, DP, etc. The structure should be like this.

Swetha-kodam commented 2 years ago

Thanks, I'll check it out.

On Wed, Sep 21, 2022, 10:27 PM Sourav Das @.***> wrote:

Yeah - you have to create a sidebar for Resources and create categories for each topic like FL, DP, etc. The structure should be like this.

  • Resources
    • Federated Learning
    • Differential Privacy
    • Homomorphic Encryption
    • Secure Multi-Party Computation

— Reply to this email directly, view it on GitHub https://github.com/OpenPrivacyTech/openprivacytech.org/issues/3#issuecomment-1253981577, or unsubscribe https://github.com/notifications/unsubscribe-auth/AXNB232VFU5QSYIV77WLBI3V7M47TANCNFSM6AAAAAAQRAXDQI . You are receiving this because you were assigned.Message ID: @.***>

Swetha-kodam commented 2 years ago

hello... @souravcipher Actually I've a doubt, I'm trying to build sidebar using html and css. Is that fine? or as mentioned in docusaurus should we built it in react? If using html and css, can uh help me out where are those specific files.

souravcipher commented 2 years ago

You don't need to write separate HTML/CSS codes to create a sidebar just follow the sidebar documentation. Sidebar is already there all you have to do is add a directory with the name(resources), add the .md files and add it in the .js file. The structure should be like this -

either -

or

I'd suggest following these steps to understand more

  1. Read the documentation first.
  2. Install a new project(from here) on your machine and understand how the docusaurus works.
  3. Check out the project structure, sidebar js, plugins, config files, etc.
  4. Once you understand the whole thing come back to this project and implement the sidebar with the structure I have mentioned above.
  5. You can also join the docusaurus discord and ask for help.

If you complete this issue you will be comfortable working with other static generators like Jekyll, Hugo, etc.

Swetha-kodam commented 2 years ago
Thanks a lot for making your time  and for a brief explanation. Now I got clear idea. Sure I’ll go through everything as uh mentioned and will complete this issue Sent from Mail for Windows From: Sourav DasSent: 23 September 2022 19:26To: OpenPrivacyTech/openprivacytech.orgCc: Swetha-kodam; AssignSubject: Re: [OpenPrivacyTech/openprivacytech.org] Create sidebar for Resources (Issue #3) You don't need to write separate HTML/CSS codes to create a sidebar just follow the sidebar documentation. Sidebar is already there all you have to do is add a directory with the name(resources) and add the .md files. The structure should be like this -either -docs/resources/ federated-learning.mddifferential-privacy.mdhomomorphic-encryption.mdsecure-multi-party-computation.mdor/resources/ federated-learning.mddifferential-privacy.mdhomomorphic-encryption.mdsecure-multi-party-computation.mdI'd suggest following these steps to understand moreRead the documentation first.Install a new project(from here) on your machine and understand how the docusaurus works.Check out the project structure, sidebar js, plugins, config files, etc.Once you understand the whole thing come back to this project and implement the sidebar with the structure I have mentioned above.You can also join the docusaurus discord and ask for help.If you complete this issue you will be comfortable working with other static generators like Jekyll, Hugo, etc.—Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you were assigned.Message ID: ***@***.***> 
souravcipher commented 2 years ago

Hi @Swetha-kodam, any update on this?

please let me know how I can help!

RidhamRj commented 2 years ago

hey is this repo for hacktoberfest2022?

RidhamRj commented 2 years ago

@souravcipher

souravcipher commented 2 years ago

Hi @RidhamRj, yeah!

We are participating in hacktoberfest.

RidhamRj commented 2 years ago

Hi @RidhamRj, yeah!

We are participating in hacktoberfest.

All right i will go through the docs first By this repo i came through quite an interesting feature i didn't knew

Preet-Sojitra commented 2 years ago

If this issue still open then I would I to work on this

Preet-Sojitra commented 2 years ago

@RidhamRj are you working on this?

RidhamRj commented 2 years ago

@RidhamRj are you working on this?

actually first i am going through the docs i was trying add sidebar but myself was stuck so will tell you if there's any update

RidhamRj commented 2 years ago

If this issue still open then I would I to work on this

for me it would take some time i will let you know the updates

Preet-Sojitra commented 2 years ago

ok no problem 👍

Swetha-kodam commented 2 years ago
Hello..Actually I’ve gone through entire documentation of docusaurus and  got some idea. I tried to it create  a pull request but the changes are not showing in my repository.  Sent from Mail for Windows From: Sourav DasSent: 29 September 2022 01:11To: openprivacytech/openprivacytech.orgCc: Swetha-kodam; MentionSubject: Re: [openprivacytech/openprivacytech.org] Create sidebar for Resources (Issue #3) Hi @Swetha-kodam, any update on this?please let me know how I can help!—Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you were mentioned.Message ID: ***@***.***> 
ziarparvaiz commented 2 years ago

@souravcipher Can you give me sidebar list I will do this I have a experience on docusaurus I did a project on docusaurus If you wouldn't mind I can do this for you.

souravcipher commented 2 years ago

Hi @ziarparvaiz!

Contributions are welcome. I was about to complete it this weekend but go ahead as you already have the experience with docusaurus!

ziarparvaiz commented 2 years ago

Thanks share to me sidebar list and assign me this issue to.

souravcipher commented 2 years ago

Yeah - you have to create a sidebar for Resources and create categories for each topic like FL, DP, etc. The structure should be like this.

  • Resources
    • Federated Learning
    • Differential Privacy
    • Homomorphic Encryption
    • Secure Multi-Party Computation

@ziarparvaiz

souravcipher commented 2 years ago

You don't need to write separate HTML/CSS codes to create a sidebar just follow the sidebar documentation. Sidebar is already there all you have to do is add a directory with the name(resources), add the .md files and add it in the .js file. The structure should be like this -

either -

  • docs/resources/
    • federated-learning.md
    • differential-privacy.md
    • homomorphic-encryption.md
    • secure-multi-party-computation.md

or

  • /resources/
    • federated-learning.md
    • differential-privacy.md
    • homomorphic-encryption.md
    • secure-multi-party-computation.md

I'd suggest following these steps to understand more

  1. Read the documentation first.
  2. Install a new project(from here) on your machine and understand how the docusaurus works.
  3. Check out the project structure, sidebar js, plugins, config files, etc.
  4. Once you understand the whole thing come back to this project and implement the sidebar with the structure I have mentioned above.
  5. You can also join the docusaurus discord and ask for help.

If you complete this issue you will be comfortable working with other static generators like Jekyll, Hugo, etc.

@ziarparvaiz

ziarparvaiz commented 2 years ago

😊 @souravcipher Okay I will do this please assign me this issue. & Check my docusaurus project if you like any features there tell me

Repo:- https://github.com/Fire-Oceann/BB-TR-Kaynak Website:- https://bb-tr-kaynak.netlify.app/

The website is Turkish don't pay attention you check the UI Component and tell me.

ziarparvaiz commented 2 years ago

@souravcipher If that's okay, I'll send.

sidebarList

souravcipher commented 2 years ago

The /docs will have different sets of documentation; I want to have them separately for now!

Could you please make the Resouces a separate sidebar?

the structure should be /resources/

Without the dropdown, each .md file should be separated and when ''Resources'' is clicked it should open the federated-learning.md first.

sorry for the confusion, I think this is better and should work for me! There will be more pages as well.

ziarparvaiz commented 2 years ago

The /docs will have different sets of documentation; I want to have them separately for now!

Could you please make the Resouces a separate sidebar?

the structure should be /resources/

* federated-learning.md

* differential-privacy.md

* homomorphic-encryption.md

* secure-multi-party-computation.md

Without the dropdown, each .md file should be separated and when ''Resources'' is clicked it should open the federated-learning.md first.

sorry for the confusion, I think this is better and should work for me! There will be more pages as well.

I can do that, but there is a URL conflict. You already have a /resources page, we need to change it to the filename. https://www.openprivacytech.org/resources/

souravcipher commented 2 years ago

For the current resource page content just move it to the resources folder, just like the docs folder! I'll move the contents to different pages!

souravcipher commented 2 years ago

yeah

The /docs will have different sets of documentation; I want to have them separately for now! Could you please make the Resouces a separate sidebar? the structure should be /resources/

* federated-learning.md

* differential-privacy.md

* homomorphic-encryption.md

* secure-multi-party-computation.md

Without the dropdown, each .md file should be separated and when ''Resources'' is clicked it should open the federated-learning.md first. sorry for the confusion, I think this is better and should work for me! There will be more pages as well.

I can do that, but there is a URL conflict. You already have a /resources page, we need to change it to the filename. https://www.openprivacytech.org/resources/

I see, this page needs to be removed I guess for the URL conflict or it can be a category page maybe? what do you suggest?

Both work for me though! You can go ahead and submit a PR. I'll review the PR and leave the comments there!

ziarparvaiz commented 2 years ago

I will transfer the file to the content on the resources page (/contents/resources/into.md) and (/src/page/resources.md) delete It

ziarparvaiz commented 2 years ago

Ok, I got you, I'll send a PR.

Swetha-kodam commented 2 years ago

Hello... I'll start working on it from now on.

On Wed, Sep 21, 2022, 8:41 AM Sourav Das @.***> wrote:

Assigned #3 https://github.com/OpenPrivacyTech/openprivacytech.org/issues/3 to @Swetha-kodam https://github.com/Swetha-kodam.

— Reply to this email directly, view it on GitHub https://github.com/OpenPrivacyTech/openprivacytech.org/issues/3#event-7427033664, or unsubscribe https://github.com/notifications/unsubscribe-auth/AXNB235FGTIUI2EKBMARM6LV7J4GVANCNFSM6AAAAAAQRAXDQI . You are receiving this because you were assigned.Message ID: @.*** .com>