[DOC] add links and edit buttons to doc

[Remi-Gau]

closes none

• add an edit button to the doc
• add links to github repo and twitter in the footer

[github-actions]

👋 @Remi-Gau Thanks for creating a PR!

Until this PR is ready for review, you can include the [WIP] tag in its title, or leave it as a github draft.

Please make sure it is compliant with our contributing guidelines. In particular, be sure it checks the boxes listed below.

• PR has an interpretable title.
• PR links to Github issue with mention Closes #XXXX (see our documentation on PR structure)
• Code is PEP8-compliant (see our documentation on coding style)
• Changelog or what's new entry in doc/changes/latest.rst (see our documentation on PR structure)

For new features:

• There is at least one unit test per new function / class (see our documentation on testing)
• The new feature is demoed in at least one relevant example.

For bug fixes:

• There is at least one test that would fail under the original bug conditions.

We will review it as quick as possible, feel free to ping us with questions if needed.

[codecov]

Codecov Report

Merging #3964 (ce869a2) into main (38fb768) will increase coverage by 0.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #3964      +/-   ##
==========================================
+ Coverage   91.78%   91.79%   +0.01%     
==========================================
  Files         134      134              
  Lines       15772    15772              
  Branches     3284     3284              
==========================================
+ Hits        14476    14478       +2     
+ Misses        752      751       -1     
+ Partials      544      543       -1     

Flag	Coverage Δ
macos-latest_3.10	91.70% <ø> (ø)
macos-latest_3.11	91.70% <ø> (ø)
macos-latest_3.8	91.67% <ø> (ø)
macos-latest_3.9	91.67% <ø> (ø)
ubuntu-latest_3.10	91.70% <ø> (ø)
ubuntu-latest_3.11	91.70% <ø> (ø)
ubuntu-latest_3.8	91.67% <ø> (ø)
ubuntu-latest_3.9	91.67% <ø> (ø)
windows-latest_3.10	91.64% <ø> (ø)
windows-latest_3.11	91.64% <ø> (ø)
windows-latest_3.8	91.61% <ø> (ø)
windows-latest_3.9	91.61% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

see 1 file with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[bthirion]

Nice !
Looks like it broke the CI...

[ymzayek]

We can also add mastodon https://fosstodon.org/@nilearn and discord too.

The edit button will allow anyone to edit and directly commit to main? I'd prefer to always go through PRs if it's possible

[ymzayek]

Failures seem unrelated; see main. I'll open a PR to fix

[Remi-Gau]

We can also add mastodon https://fosstodon.org/@nilearn and discord too.

Good idea. Will add those.

The edit button will allow anyone to edit and directly commit to main? I'd prefer to always go through PRs if it's possible

Technically the edit button is always there on the github interface, so we already have this problem. This edit button makes just easier to know what doc page cooresponds to what github document.

If we set up our branch protection rules properly, this "commit to main" should be avoidable.

Here is what it looks like on the BIDS specification.

And on another repo where I set the rules so no direct commit to the default branch is possible.

On our side we get no such warning.

[ymzayek]

Technically the edit button is always there on the github interface, so we already have this problem. This edit button makes just > easier to know what doc page cooresponds to what github document.

Ok I misunderstood the intention so thanks for clarifying.

If we set up our branch protection rules properly, this "commit to main" should be avoidable.

Indeed

[Remi-Gau]

We can also add mastodon https://fosstodon.org/@nilearn and discord too.

what it would look like

[ymzayek]

it would be checking this option then for rules on main branch?

[Remi-Gau]

it would be checking this option then for rules on main branch?

Yes and this one if you want it to apply to people with admin access (because mistakes happen... 😉 )

[Remi-Gau]

by the way I think we can also have twitter, discord and mastodon badge in the top of the readme

[ymzayek]

Yes and this one if you want it to apply to people with admin access (because mistakes happen... 😉 )

Done

[Remi-Gau]

Yes and this one if you want it to apply to people with admin access (because mistakes happen... 😉 )

Done

Confirmed by me trying to do a manual edit.

Thanks!!

[Remi-Gau]

And with the badges

[ymzayek]

Looks good! Can you rebase on main?

[Remi-Gau]

Looks good! Can you rebase on main?

Avec plaisir.