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

Use pkgdown website #570

Merged
merged 29 commits into from Jun 30, 2020
Merged

Use pkgdown website #570

merged 29 commits into from Jun 30, 2020

Conversation

schloerke
Copy link
Collaborator

@schloerke schloerke commented Jun 26, 2020

This PR does NOT improve the documentation.

The goal of the PR is to transfer content from https://github.com/rstudio/apis-plumber/ to this repo. This will allow for all developer documentation and book documentation to be hosted within the same repo.

Work still needs to be done in presenting the reference page and other content tweaks.

PR task list:

  • Update NEWS
  • [NA] Add tests
  • Update documentation with devtools::document()

@schloerke schloerke added this to the v0.5.0 - Next CRAN release milestone Jun 26, 2020
R/plumber-step.R Outdated Show resolved Hide resolved
@meztez
Copy link
Collaborator

@meztez meztez commented Jun 26, 2020

So excited for the documentation to be using pkgdown, great job @schloerke .

schloerke added 2 commits Jun 26, 2020
* master:
  Add router modifier tag support (`#' @plumber`) (#568)
  Clean up print method (#565)
@schloerke schloerke self-assigned this Jun 26, 2020
@schloerke schloerke requested a review from cpsievert Jun 26, 2020
.github/workflows/pkgdown.yaml Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
vignettes/toc.css Outdated Show resolved Hide resolved
vignettes/style.css Outdated Show resolved Hide resolved
@cpsievert cpsievert self-requested a review Jun 26, 2020
Copy link
Contributor

@cpsievert cpsievert left a comment

LGTM pending suggestions

@cpsievert
Copy link
Contributor

@cpsievert cpsievert commented Jun 26, 2020

Should also setup netlify redirects so that a https://www.rplumber.io/docs links redirects to the right location

See some examples at https://github.com/cpsievert/plotly_book/blob/master/docs/_redirects

@schloerke
Copy link
Collaborator Author

@schloerke schloerke commented Jun 26, 2020

Must wait until Jeff changes netlify settings

@schloerke schloerke mentioned this pull request Jun 30, 2020
3 tasks
@schloerke schloerke merged commit 3ddb87d into master Jun 30, 2020
9 of 16 checks passed
@schloerke schloerke deleted the pkgdown branch Jun 30, 2020
@meztez meztez mentioned this pull request Jul 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants