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 documentation for all remaining modules in Modules.md and added a link in info.json for every Module. #555

Merged
merged 7 commits into from
Dec 27, 2018

Conversation

Divy123
Copy link
Member

@Divy123 Divy123 commented Dec 24, 2018

… info.json of each Module

Fixes #506

Make sure these boxes are checked before your pull request (PR) is ready to be reviewed and merged. Thanks!

  • tests pass -- look for a green checkbox ✔️ a few minutes after opening your PR -- or run tests locally with rake test
  • code is in uniquely-named feature branch and has no merge conflicts
  • PR is descriptively titled
  • ask @publiclab/reviewers for help, in a comment below

We're happy to help you get this ready -- don't be afraid to ask for help, and don't be discouraged if your tests fail at first!

If tests do fail, click on the red X to learn why by reading the logs.

Please be sure you've reviewed our contribution guidelines at https://publiclab.org/contributing-to-public-lab-software

Thanks!

@Divy123
Copy link
Member Author

Divy123 commented Dec 24, 2018

@tech4GT please review.

@harshkhandeparkar
Copy link
Member

@Divy123 can you please change the position of already existing module docs so that they are in alphabetical order too.

@harshkhandeparkar
Copy link
Member

harshkhandeparkar commented Dec 25, 2018

You can also add an index at the top of the page if you want to.

@oorjitchowdhary
Copy link
Member

@Divy123 can you please change the position of already existing module docs so that they are in alphabetical order too.

I don't think that's required...

@oorjitchowdhary
Copy link
Member

That is some great work @Divy123 ! 🎉

@harshkhandeparkar
Copy link
Member

I don't think that's required...

Ok

@harshkhandeparkar
Copy link
Member

But how about an index ?

@Divy123
Copy link
Member Author

Divy123 commented Dec 25, 2018

Cool! I am adding the index at the top of Modules.md file.
Just one thing that I was thinking to add a clickable index and for that I have to use markdown-toc.
Should I go ahead with this?
@oorjitchowdhary @harshkhandeparkar

@harshkhandeparkar
Copy link
Member

harshkhandeparkar commented Dec 25, 2018

@Divy123, you can just add link like [link-name](#link-to-module). You just have to replace spaces with hyphens '-' and remove all brackets.

E.G: [Average](#average-module-average)
This will link to average module in the Modules.md file.

#link-to-module is just the heading given to the module like Blend Module (blend) => #blend-module-blend

@Divy123
Copy link
Member Author

Divy123 commented Dec 25, 2018

@harshkhandeparkar it works as required now. Sorry for two extra commits as I was doing some task and forgot to do some changes. Please review.

@harshkhandeparkar
Copy link
Member

harshkhandeparkar commented Dec 26, 2018

Awesome work !

@harshkhandeparkar
Copy link
Member

And the two commits are not a problem the pr is merged as a single commit.

@Divy123
Copy link
Member Author

Divy123 commented Dec 26, 2018

Thanks @harshkhandeparkar .

@tech4GT
Copy link
Member

tech4GT commented Dec 26, 2018

@Divy123 Can you please sum up the stuff you pulled off here? That would be great since I see a lot of changes.

@Divy123
Copy link
Member Author

Divy123 commented Dec 26, 2018

@tech4GT I have changed/updated Modules.md file by adding the documentation of all remaining modules.
Next I have added a link to Modules.md file in info.json of every module .

@tech4GT
Copy link
Member

tech4GT commented Dec 26, 2018

Great!! Divy if you have spell checked we can go ahead and merge here!

Copy link
Member

@tech4GT tech4GT left a comment

Choose a reason for hiding this comment

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

Divy can you also please run grunt build and commit the dist files. Do make sure to pull the latest code from main branch before doing it though. :)

@Divy123
Copy link
Member Author

Divy123 commented Dec 26, 2018

@tech4GT please have a look. I have made the necessary changes.

@tech4GT tech4GT merged commit 901cf6a into publiclab:main Dec 27, 2018
@tech4GT
Copy link
Member

tech4GT commented Dec 27, 2018

Oh I should have squashed your commits! My bad 😅

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

Successfully merging this pull request may close these issues.

4 participants