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

Added document section with required Links #143

Closed
wants to merge 8 commits into from
Closed
Changes from 4 commits
Commits
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
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,14 @@ Anitab-Forms is an application that simplifies the processing and selection proc

Documentation for the project is hosted [here](https://osp-web-docs.surge.sh/). We use `Docusaurus` for maintaining the documentation of the project.

### Few Useful Links:
1. **anitab-org wiki** : [Visit](https://github.com/anitab-org/anitab-forms-web/wiki)
2. **Open Sessions** : [Visit](https://meet.google.com/eqb-nuut-kqm)
Copy link
Member

Choose a reason for hiding this comment

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

@Aaishpra Is an open session link necessary in this? Because this may change in future.

Copy link
Member

Choose a reason for hiding this comment

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

Yes, it can definitely change, Shall we add the document link of our open sessions instead of this?

3. **GSoC** youtube video link : [Visit](https://youtu.be/3A746GppZ0Y)
4. **Setting up the project** youtube video link : [Visit](https://youtu.be/_b2RQGbYN9w)
5. **Question in Zulip chats** link : [Visit](https://anitab-org.zulipchat.com/#narrow/stream/223070-questions)
6. **Announcement in Zulip chats** link : [Visit](https://anitab-org.zulipchat.com/#narrow/stream/213491-announcements)
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
6. **Announcement in Zulip chats** link : [Visit](https://anitab-org.zulipchat.com/#narrow/stream/213491-announcements)
6. [Announcement in Zulip chats](https://anitab-org.zulipchat.com/#narrow/stream/213491-announcements): In this stream, all the important decision are announced by admins related to anitab-org opensource.

What do you think @Aaishpra about this representation i.e. link followed by some detail? This can be done for all the links.

Copy link
Author

Choose a reason for hiding this comment

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

Can I do this changes?

Copy link
Member

@Aaishpra Aaishpra May 24, 2021

Choose a reason for hiding this comment

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

This is a good idea but I am still not sure about adding announcement and questions stream links in the readme as they are common streams and not specifically dedicated to this project. Just adding links to our project stream should be fine. 🤔 What do you think?

Copy link
Member

Choose a reason for hiding this comment

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

Although we can definitely add details for other streams.
@StarTrooper08 can you add these details by yourself or would you like some help?

Copy link
Author

Choose a reason for hiding this comment

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

This is a good idea but I am still not sure about adding announcement and questions stream links in the readme as they are common streams and not specifically dedicated to this project. Just adding links to our project stream should be fine. 🤔 What do you think?

I have one idea ,
we can just add one zulip chat link instead of those 2 channels links of zulip chat.

What do you say??

Copy link
Member

Choose a reason for hiding this comment

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

Ya, and the link should take you to the anitab-forms stream.(although I think we already have one in the badge).
Let's see what @codesankalp says

Copy link
Author

Choose a reason for hiding this comment

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

Although we can definitely add details for other streams.
@StarTrooper08 can you add these details by yourself or would you like some help?

Ok I will first try of my own and if stuck somewhere I will take help .

Copy link
Author

Choose a reason for hiding this comment

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

Ya, and the link should take you to the anitab-forms stream.(although I think we already have one in the badge).
Let's see what @codesankalp says

Ok


## Setup

- To setup the project locally go through [this wiki page](https://github.com/anitab-org/anitab-forms-web/wiki/Fork,-Clone,-Remote-and-Pull-Request).
Expand Down