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

Remove redundant files in docs and discuss general reconfiguration #351

Open
sangfrois opened this issue Nov 13, 2020 · 5 comments
Open
Labels
Discussion Discussion of a concept or implementation. Need to stay always open. Documentation This issue or PR is about the documentation Good first issue Good for newcomers

Comments

@sangfrois
Copy link
Member

Reorganization of physiopy's documentation -> Removal of files in phys2bids

I have pushed a few changes on physiopy.github.io PR#2. Essentially, we want to have a main website for the community that redirects the users to each package's readthedocs page.

We don't want to be redundant, so THESE FILES HAVE TO BE DELETED from phys2bids 💯 :

  • phys2bids/docs/CODE_OF_CONDUCT.rst became physiopy/docs/community/CODE_OF_CONDUCT.md
  • phys2bids/docs/contributorfile.rsr became physiopy/docs/community/contributorfile.md
  • phys2bids/docs/bestpractices.rst became physiopy/docs/community/best-practices.md

Outstanding questions

  • What else do we want to move to physiopy.github.io ?
@sangfrois sangfrois added Documentation This issue or PR is about the documentation Good first issue Good for newcomers Discussion Discussion of a concept or implementation. Need to stay always open. labels Nov 13, 2020
@eurunuela
Copy link
Collaborator

What about phys2bids/docs/contributing.rsr ?

Maybe the "why use BIDS?" one too?

What do you think @RayStick @smoia ?

@smoia
Copy link
Member

smoia commented Nov 17, 2020

Definitely contributing.rst, but I would keep "why use BIDS" here for the moment. If/when we expand it, we can change it.

@sangfrois
Copy link
Member Author

@smoia definitely would keep controbuting.rst ?

There were parts that seemed to be phys2bids specific... Am I correct in assuming this would have to be adapted if moved?

@smoia
Copy link
Member

smoia commented Nov 17, 2020

Ah, I see why you say so.

The only phys2bids specific part I see is in the section Contributing with test files - but it's actually not phys2bids specific - we can change the sentence from:

The file contribution should come with a json file of the same name that contains the necessary information to run phys2bids on that file contribution.

To

The file contribution should come with a json file of the same name that contains the necessary information to run our packages on that file.

Is there anything else I'm missing?

@smoia
Copy link
Member

smoia commented Nov 17, 2020

For the rest, that's our general contribution guidelines, so it should be very much package unspecific and in physiopy.github.io!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Discussion Discussion of a concept or implementation. Need to stay always open. Documentation This issue or PR is about the documentation Good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants