FCP-INDI / fcp-indi.github.io

Github Pages Repo for FCP-INDI
https://fcp-indi.github.io
2 stars 8 forks source link

📝 Document nested config changes #248

Closed shnizzedy closed 3 years ago

shnizzedy commented 3 years ago

Fixes

Related to https://github.com/FCP-INDI/C-PAC/pull/1411 by @shnizzedy Related to https://github.com/FCP-INDI/C-PAC/issues/1366 by @sgiavasis Related to https://github.com/FCP-INDI/fcp-indi.github.com/discussions/249 by @shnizzedy and https://github.com/FCP-INDI/fcp-indi.github.com/discussions/249#discussioncomment-339526 by @sgiavasis Includes #247

Description

These changes are live on my fork.

  1. Documents the change to a nested config and lists the mappings from the old syntax to the new
  2. Adds a warning to the "Design A Pipeline" section that alerts users to this change
  3. Moves user pipeline-specific pages (1.7-1.8-nesting-mappings, default, design_a_pipeline, pipeline_config, and preconfig) from /user to user/pipelines
  4. Replaces the tables built from docs/_sources/_static/params (like screenshot of a table) with relevant lines from the default pipeline config (like screenshot of excerpt)

Screenshots

warning screenshot mappings screenshot

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. ```
shnizzedy commented 3 years ago

need to update line numbers & wait for C-PAC:develop_v1.8_convergence to be merged into C-PAC:develop or C-PAC:master