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.

Sign up for GitHub

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

fix: made necessary changes to docusaurus #123

Closed
wants to merge 3 commits into from
Closed

fix: made necessary changes to docusaurus #123

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c83864a
fix: made necessary changes to docusaurus
ashwinijha6 Mar 12, 2021
a498c9c
fix: changed the command
ashwinijha6 Mar 15, 2021
fda6e1f
Merge branch 'develop' into webdocusaurus
ashwinijha6 Mar 15, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ yarn build

This command generates static content into the `build` directory and can be served using any static contents hosting service.

**Note**: You can use `npm run serve` to test your build locally.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
**Note**: You can use `npm run serve` to test your build locally.
**Note**: You can use `yarn serve` to test your build locally.

Copy link
Author

@ashwinijha6 ashwinijha6 Mar 13, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

@codesankalp could you pls explain why I should replace npm run serve with yarn serve ? I don't see much difference in it, but I guess yarn is much faster than npm.

Copy link
Member

Choose a reason for hiding this comment

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

@ashwinijha6 You have added the same note line twice. As the first few lines of the README include yarn start, yarn build etc.. then according to the flow there should be yarn serve for testing the build locally.
I think it is a valid reason.

Copy link
Author

Choose a reason for hiding this comment

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

Yes that was on purpose @codesankalp. I can do one thing that is change the command after yarn build to yarn serve & let the second command after npm run build be as it is OR remove the second command. What do you think?


## Deployment

```
Expand All @@ -46,6 +48,8 @@ Deploy using surge with the following steps:
```
npm run build
```
**Note**: You can use `npm run serve` to test your build locally.

3. Run this command inside the root/docs directory of project:
```
surge build/
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/Home.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Home
slug: /
---

Welcome to the Open Source Programs Web!
Welcome to the Open Source Programs Web
## About
**Open Source Programs** is a project which aims towards simplifying the management work of the mentors and organizations. The goal is to make reviewing and notifying simpler, systematic and manageable. This will help in easy processing and hosting of the Open Source Programs be it a 4-week or a 6-month long program. This was proposed as an [original GSoC'20 project](https://summerofcode.withgoogle.com/organizations/4752039663370240/) by [Bismita Guha](https://github.com/bismitaguha) under the guidance of [Maybelline Burgos](https://github.com/mayburgos), [Monal Shadi](https://github.com/Monal5031), [Abha Wadjikar](https://github.com/abha224) and [Siddharth Venu](https://github.com/sidvenu) as mentors.
As the first version of the application, the focus will be on the implementation of the following aspects:
Expand All @@ -22,4 +22,4 @@ The backend of this project can be found [here](https://github.com/anitab-org/op
In 1987, computer scientist Anita Borg founded a digital community for women in computing. Today, AnitaB.org works with technologists in more than 80 countries, and partners with academic institutions and Fortune 500 companies worldwide.

## Contact
To contribute here or any other projects associated with AnitaB.org checkout [our Zulip space](https://anitab-org.zulipchat.com/).
To contribute here or any other projects associated with AnitaB.org checkout [our Zulip space](https://anitab-org.zulipchat.com/).
2 changes: 1 addition & 1 deletion docs/docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ module.exports = {
items: [
{
label: 'Backend Docs',
href: 'https://github.com/anitab-org/open-source-programs-backend/wiki',
href: 'https://osp-backend-docs.surge.sh/',
}
],
},
Expand Down
12 changes: 0 additions & 12 deletions docs/src/pages/styles.module.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,3 @@
align-items: center;
justify-content: center;
}

.features {
display: flex;
align-items: center;
padding: 2rem 0;
width: 100%;
}

.featureImage {
height: 200px;
width: 200px;
}