Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

MRG: migrate old docs #371

Merged
merged 1 commit into from
Mar 24, 2020
Merged

MRG: migrate old docs #371

merged 1 commit into from
Mar 24, 2020

Conversation

sappelhoff
Copy link
Member

@sappelhoff sappelhoff commented Mar 24, 2020 •
edited
Loading

closes #369

Note: I have revoked the circleci key we previously used for pushing the docs and added a new one. This way, our automated scripts from the past won't be able to screw with our new docs.

This diff is probably completely unreadable, so here is a concise description of what this PR does:

  1. Remove all old docs.
  2. add four subdirectories containing locally build and manually checked OLD docs
    1. v0.1
    2. v0.2
    3. v0.3
    4. stable (which is a duplicate of v0.3), this is needed for the new doc workflow
  3. add a new .nojekyll file
  4. add a new index.html (posted below) ... this file will redirect all users to the stable docs --> which will then have a dropdown menu to navigate to other versions
<!DOCTYPE HTML>
<html lang="en-US">
    <head>
        <meta charset="UTF-8">
        <meta http-equiv="refresh" content="1; url=https://mne.tools/mne-bids/stable/index.html">
        <script type="text/javascript">
            window.location.href = "https://mne.tools/mne-bids/stable/index.html"
        </script>
        <title>Page Redirection</title>
    </head>
    <body>
        If you are not redirected automatically, follow this <a href='https://mne.tools/mne-bids/stable/index.html'>link</a>.
    </body>
</html>

Note: Once #370 is merged (but merge AFTER this one, #371 ), CircleCI will build dev docs and push them into a new dev directory on this (gh-pages) branch.

Each doc version is then saved in a subdirectory on this branch ... only the docs in the dev directory will be regularly updated by circleci.

Every release a maintainer will manually:

  1. add a new folder vX.Y containing the docs of the new stable version
  2. replace the contents of the stable folder with the new stable version

I described the logic in this wiki: https://github.com/mne-tools/mne-bids/wiki/Explanation-of-Documentation-Setup

I also updated the release protocol with the two new steps that are now coming in:

  1. before a release, add a line to doc/_templates/navbar.html
  2. after the release, build the stable docs and push html contents to gh-pages into the stable and into the vX.Y subdirectories

Merge checklist

Maintainer, please confirm the following before merging:

  • All comments resolved
  • This is not your own PR
  • All CIs are happy
  • PR title starts with [MRG]
  • whats_new.rst is updated
  • PR description includes phrase "closes <#issue-number>"
  • Commit history does not contain any merge commits

@sappelhoff sappelhoff closed this Mar 24, 2020
@sappelhoff sappelhoff reopened this Mar 24, 2020
@sappelhoff sappelhoff mentioned this pull request Mar 24, 2020
Merged
7 tasks
@sappelhoff
Copy link
Member Author

@agramfort @jasmainak I finished overhauling the docs. We now need to merge first #371 (this one) and then #370 to make everything work.

I followed the plan from #369 and everything worked out. Even binder should work for all versions now.

@jasmainak jasmainak merged commit a54f028 into mne-tools:gh-pages Mar 24, 2020
@jasmainak
Copy link
Member

Thanks @sappelhoff !

@sappelhoff sappelhoff mentioned this pull request Apr 4, 2020
Closed
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@agramfort agramfort agramfort approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@sappelhoff @jasmainak @agramfort