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

Feature: Reorganize repo to prepare for Maintainer Course. #135

Closed
2 tasks done
BekahHW opened this issue Mar 14, 2024 · 6 comments · Fixed by #138
Closed
2 tasks done

Feature: Reorganize repo to prepare for Maintainer Course. #135

BekahHW opened this issue Mar 14, 2024 · 6 comments · Fixed by #138

Comments

@BekahHW
Copy link
Member

BekahHW commented Mar 14, 2024

Type of feature

🍕 Feature

Current behavior

Right now, we only have one course here, but soon we'll have two 🎉 We need to reorganize the repo to allow for both courses and remove any unnecessary repetition. For example, we'll only need one COC, not a COC for each course.

Suggested solution

Following @adiati98's suggestions in: open-sauced/maintainer-intro-course#60

Additional context

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct

Contributing Docs

  • I agree to follow this project's Contribution Docs
@CBID2
Copy link
Contributor

CBID2 commented Mar 14, 2024

Can I help with this @BekahHW?

@BekahHW
Copy link
Member Author

BekahHW commented Mar 15, 2024

@CBID2 this is for someone on the docs team.

@CBID2
Copy link
Contributor

CBID2 commented Mar 15, 2024

@CBID2 this is for someone on the docs team.

Ok

@adiati98
Copy link
Member

@BekahHW just a reminder. Every course's folder still need to have their own README, CONTRIBUTING, and i18n Guidelines files.

As CONTRIBUTING and i18n Guidelines have similar content, maybe we can try to combine them together and update the content to accomodate both courses in the Homepage or something.
But a README for every course is a must because it serves as the landing page of each course.

I'll take a look at this when I can make the time.

@BekahHW
Copy link
Member Author

BekahHW commented Mar 15, 2024

@adiati98 yes! I know we definitely need three readmes here.

@adiati98 adiati98 self-assigned this Mar 18, 2024
@adiati98
Copy link
Member

adiati98 commented Mar 18, 2024

@BekahHW I'm currently working on this. And I have several questions:

  1. We want to have one CONTRIBUTING, i18n Guidelines and Community Translations Guidelines. Should I update the content to accomodate both courses and reflect the future changes in this PR, or wait until we move the maintainer course?

  2. We have a link in every chapter to edit the page on GitHub. Do we want to keep this or do we want to use the docsify-edit-on-github plugin? If we want to keep the current, we need to adjust the links manually in this PR. Besides the last time that it's updated 3 years ago, the other downside with this plugin is I don't know yet how to position it to the bottom. By default, it's on top right as screenshot below:

    Screenshot 2024-03-18 213100

  3. We will apply pagination plugin. Is it okay if I apply the plugin from this PR? That way, I can also save time from editing the links manually.

I will hold the rest (styling, etc.) as we only will reorganize the directories structure and update things based on the new structure here.

Thanks! 😊

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

Successfully merging a pull request may close this issue.

3 participants