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

📝 Document RBC regressors and update citations #289

Draft
wants to merge 6 commits into
base: source
Choose a base branch
from

Conversation

shnizzedy
Copy link
Member

@shnizzedy shnizzedy commented Jul 1, 2022

Documents

🚧 WIP to be drafted

Description

  • Documents regression strategies for rbc-options
  • Updates CONTRIBUTING community file
  • Transcludes CONTRIBUTING community file in developer documentation

Screenshots

rbc-options documentation

fcp-indi.github.io/docs/nightly/user/pipelines/preconfig#rbc-options-reprobrainchart-options-pipeline

CONTRIBUTING file on GitHub

https://github.com/FCP-INDI/fcp-indi.github.io/blob/rbc-regressors-update/CONTRIBUTING.rst

CONTRIBUTING transcluded in developer documentation

fcp-indi.github.io/docs/nightly/developer/documentation

Checklist

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

* Convert CONTRIBUTING from MD to RST
* Transclude CONTRIBUTING in documentation page
* Update "References and citations" section to include simplified citations via sphinxcontrib-bibtex update
@shnizzedy shnizzedy requested a review from a team July 1, 2022 21:26
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