Added document section with required Links #143

StarTrooper08 · 2021-05-20T11:07:24Z

Description

Added document section with required Links

Fixes #71

Type of Change:

Documentation

Code/Quality Assurance Only

Bug fix (non-breaking change which fixes an issue)
This change requires a documentation update (software upgrade on readme file)
New feature (non-breaking change which adds functionality pre-approved by mentors)

How Has This Been Tested?

N/A

Checklist:

My PR follows the style guidelines of this project
I have performed a self-review of my own code or materials
I have commented my code or provided relevant documentation, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
Any dependent changes have been merged
I have written Kotlin Docs whenever is applicable

Links need to be added

links of the respective points added

Added the links

StarTrooper08 · 2021-05-20T11:10:58Z

This PR should solve issue no. #71

Aaishpra · 2021-05-20T15:13:54Z

Can you add the issue number in the PR description after Fixes # so that the PR closes the issue

StarTrooper08 · 2021-05-20T16:58:33Z

Ok I will do it as soon as possible

StarTrooper08 · 2021-05-20T17:00:17Z

Done

codesankalp · 2021-05-20T17:20:19Z

@StarTrooper08 Add Fixes #<issue_number> in PR description and not in the PR title.
If you read the description you will see Fixes just add the issue number there.

StarTrooper08 · 2021-05-21T05:15:27Z

Done ✅

Aaishpra · 2021-05-21T06:46:42Z

README.md

@@ -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`** link - https://github.com/anitab-org/anitab-forms-web/wiki


Suggested change

1. **`anitab-org wiki`** link - https://github.com/anitab-org/anitab-forms-web/wiki

1. **anitab-org wiki** [link](https://github.com/anitab-org/anitab-forms-web/wiki)

Do the same with other links also

added link

StarTrooper08 · 2021-05-24T07:24:44Z

@Aaishpra do the changes I have made now is right??

codesankalp · 2021-05-24T09:38:41Z

README.md

-5. **`Question in Zulip chats`** link - https://anitab-org.zulipchat.com/#narrow/stream/223070-questions
-6. **`Announcement in Zulip chats`** link - https://anitab-org.zulipchat.com/#narrow/stream/213491-announcements
+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)


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

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

codesankalp · 2021-05-24T09:41:37Z

README.md

+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)


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.

Can I do this changes?

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?

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

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??

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

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 .

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

vj-codes · 2021-08-14T20:33:31Z

README.md

@@ -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](https://github.com/anitab-org/anitab-forms-web/wiki) : Wiki page  


Suggested change

1. [anitab-org wiki](https://github.com/anitab-org/anitab-forms-web/wiki) : Wiki page

1. [anitab-forms wiki](https://github.com/anitab-org/anitab-forms-web/wiki) : Wiki page

Aaishpra · 2021-08-29T15:55:05Z

@StarTrooper08 any updates?

[anitab-org wiki] --> [anitab-forms wiki]

StarTrooper08 · 2021-09-16T08:09:31Z

I m sorry, for the delay.

Aaishpra

Great work

Aaishpra · 2021-09-16T16:12:39Z

@codesankalp @isabelcosta have a look here

README.md

Co-authored-by: Sankalp <[email protected]>

isabelcosta

Thank you for contributing @StarTrooper08 🙌🏾

isabelcosta · 2021-09-19T15:26:02Z

@StarTrooper08 Can you run prettier, so the lint check passes please?

StarTrooper08 · 2021-09-19T15:27:38Z

Ok @isabelcosta I'll do it.
But how can I do it 😅.
Can I get help!

isabelcosta · 2021-09-19T16:06:45Z

@StarTrooper08 of course you can get help :) I just have to ping other maintainers, because I am not very well versed with frontend 😅 @Aaishpra @codesankalp
I took a look at the readme and it does say you can run: npm run lint:fix. Can you do this and push the changes?

Aaishpra

@StarTrooper08 Isabel told you the correct command or if you use yarn use yarn lint-fix once the tests are passing I can approve the PR,

codesankalp · 2021-09-20T04:25:54Z

@StarTrooper08 Rebasing your branch with the current developed branch will also make the lining test pass.

StarTrooper08 · 2021-09-25T13:33:48Z

Ok

isabelcosta · 2021-10-03T19:52:55Z

@StarTrooper08 are you still working on this? If not, let us know so we can make the ticket available again :)

StarTrooper08 · 2021-10-04T06:37:25Z

Yes yes I was stucked in some other work.

StarTrooper08 · 2021-10-10T13:45:50Z

I used the command npm run lint:fix.
But still, it's showing 1 failing check.

codesankalp · 2021-10-10T13:53:18Z

I used the command npm run lint:fix. But still, it's showing 1 failing check.

Have you rebased the branch?
After rebasing try to run the command and then push the rebased branch.

StarTrooper08 · 2021-10-10T14:07:21Z

@isabelcosta @codesankalp please have a look

codesankalp · 2021-10-10T14:21:41Z

@StarTrooper08 Can you please resolve the merge conflicts?

codesankalp · 2021-10-10T14:22:49Z

@StarTrooper08 Can you please resolve the merge conflicts?

To do this replace the develop branch package-lock.json file with your local file.
Also, I see you haven't rebased the branch (try this):

git remote add upstream [email protected]:anitab-org/anitab-forms-web.git 
git fetch upstream
git rebase upstream/develop
npm install
npm run lint:fix
git push

StarTrooper08 added 3 commits May 17, 2021 01:30

added required points

8011cca

Links need to be added

added links

abb41d2

links of the respective points added

final changes

709c80f

Added the links

StarTrooper08 mentioned this pull request May 20, 2021

docs: Add a documentation Section in the README.md #71

Open

StarTrooper08 changed the title ~~Added document section with required Links~~ Added document section with required Links #71 May 20, 2021

StarTrooper08 changed the title ~~Added document section with required Links #71~~ Added document section with required Links (Fixes #71) May 20, 2021

Aaishpra reviewed May 21, 2021

View reviewed changes

added link in proper format

bff629f

added link

codesankalp suggested changes May 24, 2021

View reviewed changes

updated

1155faa

codesankalp previously approved these changes May 26, 2021

View reviewed changes

codesankalp added the Status: Needs Review PR needs an additional review or a maintainer's review. label May 26, 2021

vj-codes reviewed Aug 14, 2021

View reviewed changes

vj-codes added Status: Changes Requested Changes are required to be done by the PR author. and removed Status: Needs Review PR needs an additional review or a maintainer's review. labels Aug 14, 2021

updated as suggested

c9e9e5f

[anitab-org wiki] --> [anitab-forms wiki]

StarTrooper08 dismissed codesankalp’s stale review via c9e9e5f September 16, 2021 08:08

Aaishpra previously approved these changes Sep 16, 2021

View reviewed changes

codesankalp suggested changes Sep 17, 2021

View reviewed changes

README.md Outdated Show resolved Hide resolved

isabelcosta dismissed Aaishpra’s stale review via fcca62c September 19, 2021 15:20

fix: space before colon

fcca62c

Co-authored-by: Sankalp <[email protected]>

isabelcosta previously approved these changes Sep 19, 2021

View reviewed changes

isabelcosta requested review from codesankalp and Aaishpra September 19, 2021 15:22

isabelcosta changed the title ~~Added document section with required Links (Fixes #71)~~ Added document section with required Links Sep 19, 2021

Aaishpra reviewed Sep 19, 2021

View reviewed changes

updated

1cabfde

StarTrooper08 dismissed isabelcosta’s stale review via 1cabfde October 10, 2021 14:05

StarTrooper08 closed this by deleting the head repository May 31, 2023

	1. `anitab-org wiki` link - https://github.com/anitab-org/anitab-forms-web/wiki
	1. anitab-org wiki [link](https://github.com/anitab-org/anitab-forms-web/wiki)

	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.

	1. [anitab-org wiki](https://github.com/anitab-org/anitab-forms-web/wiki) : Wiki page
	1. [anitab-forms wiki](https://github.com/anitab-org/anitab-forms-web/wiki) : Wiki page

Added document section with required Links #143

Added document section with required Links #143

Conversation

StarTrooper08 commented May 20, 2021 • edited by isabelcosta Loading

Description

Type of Change:

How Has This Been Tested?

Checklist:

StarTrooper08 commented May 20, 2021

Aaishpra commented May 20, 2021

StarTrooper08 commented May 20, 2021

StarTrooper08 commented May 20, 2021

codesankalp commented May 20, 2021

StarTrooper08 commented May 21, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

StarTrooper08 commented May 24, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Aaishpra May 24, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Aaishpra commented Aug 29, 2021

StarTrooper08 commented Sep 16, 2021

Aaishpra left a comment

Choose a reason for hiding this comment

Aaishpra commented Sep 16, 2021

isabelcosta left a comment

Choose a reason for hiding this comment

isabelcosta commented Sep 19, 2021

StarTrooper08 commented Sep 19, 2021 • edited Loading

isabelcosta commented Sep 19, 2021

Aaishpra left a comment

Choose a reason for hiding this comment

codesankalp commented Sep 20, 2021

StarTrooper08 commented Sep 25, 2021

isabelcosta commented Oct 3, 2021

StarTrooper08 commented Oct 4, 2021

StarTrooper08 commented Oct 10, 2021

codesankalp commented Oct 10, 2021

StarTrooper08 commented Oct 10, 2021

codesankalp commented Oct 10, 2021

codesankalp commented Oct 10, 2021 • edited Loading

StarTrooper08 commented May 20, 2021 •

edited by isabelcosta

Loading

Aaishpra May 24, 2021 •

edited

Loading

StarTrooper08 commented Sep 19, 2021 •

edited

Loading

codesankalp commented Oct 10, 2021 •

edited

Loading