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

[WIP] Doc reorganization (part 2): community and about us [docs] #1587

Merged
merged 8 commits into from
Jun 12, 2021

Conversation

OriolAbril
Copy link
Member

@OriolAbril OriolAbril commented Feb 27, 2021

Description

Continuation of the work outlined in #1331. I am not tied to any of the pages not sections.

I have edited the governace doc too: moved core contributor section way up to highlight its
importance and listed current rv council members + added link to latest elections

I also plan to significantly extend the dev guide.

Note: think about a way to showcase libraries like corner.py that support inferencedata in a similar way we showcase the inference libraries whose output can be converted to inferencedata.

Resources

A community overview statement should contain

  • Single sentence naming the community and what domain it focuses on (mission you’re trying to achieve if domain isn’t clear)
  • State who the group is for if you couldn’t include in first sentence (and maybe list examples if need to make explicit)
  • What is the purpose of the group - what does participation in the group look like (asking questions? sharing links?)
  • Anything else you need to include e.g. brief future plans, funding, how it relates to other stakeholders?

From https://www.cscce.org/

Checklist

  • Does the PR follow official PR format?
  • Is the documentation numpydoc compliant?
  • Is the fix listed in the Documentation section of the changelog?

@ahartikainen ahartikainen changed the title [WIP] Doc reoganizaiton (part 2): dev guide, community and about us [WIP] Doc reorganization (part 2): dev guide, community and about us Mar 1, 2021
@OriolAbril OriolAbril mentioned this pull request Mar 5, 2021
@codecov
Copy link

codecov bot commented Mar 26, 2021

Codecov Report

Merging #1587 (7578074) into main (2730d9f) will decrease coverage by 0.00%.
The diff coverage is n/a.

❗ Current head 7578074 differs from pull request most recent head 4428841. Consider uploading reports for the commit 4428841 to get more accurate results
Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1587      +/-   ##
==========================================
- Coverage   90.84%   90.83%   -0.01%     
==========================================
  Files         108      108              
  Lines       11825    11720     -105     
==========================================
- Hits        10742    10646      -96     
+ Misses       1083     1074       -9     
Impacted Files Coverage Δ
arviz/plots/backends/bokeh/kdeplot.py 93.37% <0.00%> (-3.40%) ⬇️
arviz/stats/density_utils.py 76.30% <0.00%> (-1.09%) ⬇️
arviz/data/base.py 97.87% <0.00%> (-0.35%) ⬇️
arviz/plots/backends/bokeh/pairplot.py 87.43% <0.00%> (-0.07%) ⬇️
arviz/plots/backends/matplotlib/pairplot.py 92.10% <0.00%> (-0.05%) ⬇️
arviz/plots/backends/matplotlib/kdeplot.py 98.85% <0.00%> (-0.03%) ⬇️
arviz/stats/stats.py 96.60% <0.00%> (ø)
arviz/plots/hdiplot.py 92.45% <0.00%> (ø)
arviz/plots/kdeplot.py 100.00% <0.00%> (ø)
arviz/plots/distplot.py 90.47% <0.00%> (ø)
... and 9 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2730d9f...4428841. Read the comment docs.

@OriolAbril OriolAbril changed the title [WIP] Doc reorganization (part 2): dev guide, community and about us [WIP] Doc reorganization (part 2): dev guide, community and about us [docs] Mar 27, 2021
@OriolAbril OriolAbril changed the title [WIP] Doc reorganization (part 2): dev guide, community and about us [docs] [WIP] Doc reorganization (part 2): community and about us [docs] Apr 16, 2021
@OriolAbril
Copy link
Member Author

After a quick look there are still some minor things to update before merging, i.e. link to corner.py probably typos, grammar... but the bulk of the PR is ready to go, we'll keep updating the dev guide on the go.

* moved core contributors to appear  before rv council to
show the importance of the core contributor group
* Added the current rv council members and link to latest elections
@OriolAbril OriolAbril merged commit e8e9f79 into main Jun 12, 2021
@OriolAbril OriolAbril deleted the dev_guide branch June 12, 2021 21:22
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.

1 participant