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

SM-Docs-Poller: Update the home page to the new standard #7

Closed
palisadoes opened this issue Jan 11, 2025 · 6 comments
Closed

SM-Docs-Poller: Update the home page to the new standard #7

palisadoes opened this issue Jan 11, 2025 · 6 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@palisadoes
Copy link
Contributor

palisadoes commented Jan 11, 2025

Our switchmap-ng repo is actively used by companies. It has become dormant and some packages are out of date. We plan to add this application to GSOC 2025 to revive it.

The exisiting monorepo will be split into a multirepo to simplify the code and allow easier contributor specialization. Four new repositories have been created for this purpose:

  1. switchmap-ng-docs the main Docusaurus based documentation website at https://docs.switchmap-ng.io/
  2. switchmap-ng-web the web UI repo with a Docusaurus docs/ directory. The documentation can be found at https://docs-web.switchmap-ng.io/
  3. switchmap-ng-poller the poller repo with a Docusaurus docs/ directory. The documentation can be found at https://docs-poller.switchmap-ng.io/
  4. switchmap-ng-api the API repo with a Docusaurus docs/ directory. The documentation can be found at https://docs-api.switchmap-ng.io/

In anticipation of this we need to update the documentation and migrate it to the respective repositories.

Background

  1. This repo has a docs/ directory for creating the Docusaurus website at https://docs-poller.switchmap-ng.io/
  2. Your changes will only need will be made to that directory and its children

Requirements

  1. Updates must based on the develop branch and merged against the develop branch
  2. This website must use the same CSS and NavBar as:
    1. https://docs.switchmap-ng.io/
  3. The code for this can be found here:
    1. https://github.com/PalisadoesFoundation/switchmap-ng-docs/tree/develop
  4. The docs/docs folder must only contain the content here:
    1. https://github.com/PalisadoesFoundation/switchmap-ng/tree/develop/docs/docs
  5. Make the homepage look like this
    1. https://docs.switchmap-ng.io/
    2. Based on the design here:
      1. https://github.com/PalisadoesFoundation/switchmap-ng-docs
  6. The NavBar must have entries for:
    1. General that links to https://docs.switchmap-ng.io/
    2. Web that links to https://docs-web.switchmap-ng.io/
    3. Poller that links to https://docs-poller.switchmap-ng.io/
    4. API that links to https://docs-api.switchmap-ng.io/
  7. Test to make sure your docusaurus site looks OK before submitting a PR

Other

Describe alternatives you've considered

  • N/A

Approach to be followed (optional)

  • N/A

Additional context

  • This CSS will be the basis for all Palisadoes Foundation Docusaurus based websites

Potential internship candidates

Please read this if you are planning to apply for a Palisadoes Foundation internship

@github-actions github-actions bot added documentation Improvements or additions to documentation unapproved labels Jan 11, 2025
@DreamCatcher369836
Copy link

Working on it.

@NishantSinghhhhh
Copy link

@DreamCatcher369836 , if you need any help I am ready to work along with you

@DreamCatcher369836
Copy link

I might give this to someone else to work on. Otherwise it will take too long.

@NishantSinghhhhh
Copy link

Sure , I am ready to work

@NishantSinghhhhh
Copy link

@palisadoes , Can I use tailwind css in this project or is it necessary to use module.css ??

@palisadoes
Copy link
Contributor Author

Don't change the methodology

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

No branches or pull requests

3 participants