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.

Sign up for GitHub

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

Jump to bottom

replace main CRAN vignette sections by links to the gh-pages #1152

Merged
merged 6 commits into from
Jun 13, 2024
Merged

replace main CRAN vignette sections by links to the gh-pages #1152

merged 6 commits into from
Jun 13, 2024

Conversation

vincentvanhees
Copy link
Member

@vincentvanhees vincentvanhees commented Jun 11, 2024 •
edited
Loading

This PR relates to our efforts to restructure all the narrative GGIR documentation #1046

In this PR I am replacing many of the paragraphs in the main CRAN vignette with a link to the new location of the text. In this way external links to CRAN vignette section will keep working, visitors are redirected to the new location, and we avoid having to maintain both new and old documentation.

As part of this:

  • Added a new vignette GGIRoutput.Rmd with the old overview of 'inspecting the results'
  • Added GGIRoutput.Rmd and GGIRParameters.Rmd as Annex such that github-pages are more self-sustained with no longer the need to reference CRAN vignettes.
  • Added household co-analysis vignette to .Rbuildignore, such that it is only available on gh-pages. In this way we minimize the number of vignettes available on CRAN.
  • Tried to filter search results in search bar from GGIR.html vignette, index.html, and all reference pages for individual functions. Not sure if the latter works, we will see when we merge this PR.
  • Rebuild the site

Checklist before merging:

  • Existing tests still work (check by running the test suite, e.g. from RStudio).
  • Added tests (if you added functionality) or fixed existing test (if you fixed a bug).
  • Clean code has been attempted, e.g. intuitive object names and no code redundancy.
  • Documentation updated:
    • Function documentation
    • Chapter vignettes for GitHub IO
    • Vignettes for CRAN
  • Corresponding issue tagged in PR message. If no issue exist, please create an issue and tag it.
  • Updated release notes in inst/NEWS.Rd with a user-readable summary. Please, include references to relevant issues or PR discussions.
  • Added your name to the contributors lists in the DESCRIPTION file, if you think you made a significant contribution.
  • GGIR parameters were added/removed. If yes, please also complete checklist below.

@vincentvanhees vincentvanhees marked this pull request as ready for review June 11, 2024 14:22
@vincentvanhees
remove explanation GGIR abbreviation + refine search results in searc…
e01a6cf 
…h bar

- Remove explanation of GGIR abbreviation. There are people we started using this in manuscripts, which is not helpful. GGIR is just the name and should not be spelled out.
- Ignore NEWS and GGIR.html vignette in search results.
- Attempt to ignore reference from search results, because visitors expect to navigate our documentation not the technical package code documentation.
@vincentvanhees vincentvanhees merged commit 51c8056 into master Jun 13, 2024
7 checks passed
@vincentvanhees vincentvanhees deleted the issue1046_simplify_mainCRANvignette branch June 13, 2024 15:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jhmigueles jhmigueles Awaiting requested review from jhmigueles

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

Successfully merging this pull request may close these issues.
1 participant
@vincentvanhees