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

Write installation guide #1487

Closed
OriolAbril opened this issue Jan 8, 2021 · 10 comments
Closed

Write installation guide #1487

OriolAbril opened this issue Jan 8, 2021 · 10 comments
Labels
Beginner Help Wanted User Documentation Documentation outside of the codebase

Comments

@OriolAbril
Copy link
Member

OriolAbril commented Jan 8, 2021

Tell us about it

Write a page about ArviZ installation that covers the basic pip and conda commands and extends with installation of optional dependencies, when should they be installed and a link to dedicated docs about using the capabilities of these optional dependencies (if necessary) for example to the Numba page. See #1331 for extra info and an overview of the documentation revamp

Thoughts on implementation

The README should link to this page after its installation section.

@OriolAbril OriolAbril added Help Wanted Beginner User Documentation Documentation outside of the codebase labels Jan 8, 2021
@arungrace88
Copy link
Contributor

Hello,
I would like to contribute on this issue. Just to let you know that I am a beginner in this open-source contribution journey.

@OriolAbril
Copy link
Member Author

Hi! Welcome! Thanks for taking on this issue. Let us know if you need any help.

@Rishabh261998
Copy link
Contributor

Hi, @OriolAbril I would like to work on this issue, I am a newcomer in open-source so I think this issue would be the best place to start with. Please let me know if I can be assigned to this issue. Thank You.

@OriolAbril
Copy link
Member Author

Similarly to what I said in #1490, let's wait a couple days to give @arungrace88 time to share any work done already on that, we want everyone to enjoy contributing to ArviZ and use their time profitably. We are all working together to build a cool library, not competing to see who works more or who works faster.

As always, either @arungrace88 or @Rishabh261998 let us know if you need any help with the issue, choosing where to work, understanding the structure of the library... we are here

@arungrace88
Copy link
Contributor

Hi @OriolAbril,
Thanks for the time. I have documented the installation steps (pip & conda forge) along with the required and optional dependencies, and saved in .rst format. Is the output expected in any other format?. Thanks.

@OriolAbril
Copy link
Member Author

Thanks, rst is great! Given our current sphinx configuration using myst, the source of our docs can be either rst or markdown, both formats get rendered nicely.

@madhucharan
Copy link
Contributor

Hi @OriolAbril , If it is still open to document a particular guide or something, please let me know. I am looking forward to working on it.

@OriolAbril
Copy link
Member Author

@madhucharan take a look at #1331, there are more ideas about guides and pages to add to the documentation. Let me know if some of the ideas there seem interesting to write.

Some of these like the developer guide pages will be really challenging though because the content that should be written there are unwritten tricks, things discussed in private chats between developers...

@Grasin98
Copy link

Hi @OriolAbril I would like to take on this on going issue and implement few ideas about guides and pages. Also, I am new to this, so would be great if you could guide me.

@OriolAbril
Copy link
Member Author

Hi @Grasin98 definitely, if you don't mind, let's move the conversation to #1331 so we can close this (same goes for @madhucharan), the installation guide has already been added and the discussion on other guides to add to the docs is at #1331

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Beginner Help Wanted User Documentation Documentation outside of the codebase
Projects
None yet
Development

No branches or pull requests

5 participants