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

Pkgdown site #102

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
Open

Pkgdown site #102

wants to merge 9 commits into from

Conversation

mstackhouse
Copy link

This pull request simply adds in a basic pkgdown site to the repository. I've additionally made some tiny updates as well as some general organization of the reference documentation to make the flow of the site a bit better.

This package is fantastic; it has great documentation and helpfully written vignettes. Without the package website, the docs are just a little tedious to reference. I'd love to see this repo launch this pkgdown site onto GitHub pages, or any other publicly accessible medium for the documentation. All the documentation is already there, and this just organizes it and makes it easily accessible.

image

@ghost
Copy link

ghost commented Jan 18, 2022

CLA assistant check
All CLA requirements met.

@hongooi73
Copy link
Collaborator

Nice, thanks! I'm not sure how to setup GH pages since I'm technically no longer an admin for this repo, but I'll ask around.

@mstackhouse
Copy link
Author

@hongooi73 I can build my own example for reference for you within my personal account and I'll link when ready.

@hongooi73
Copy link
Collaborator

@revodavid @alexkyllo what do you think?

@mstackhouse
Copy link
Author

@hongooi73 I threw up the page right here: https://mstackhouse.github.io/Microsoft365R/

Here are the necessary steps:

  • Starting here, the main part is just turning on pages for the Azure GitHub organization: https://docs.github.com/en/pages/quickstart
  • My branch for this PR already has the GitHub workflow incorporated
  • One this repository, go to Settings
  • Actions is already turned on because you have the build testing configured, but just want to mention that this needs to be enabled
  • Still under settings, go to pages
  • For the source, the workflow should automatically create a new branch called gh-pages. And the root directory should be fine.

So - that should really be it! The only quirk that I experienced with the Microsoft365R repo was that within .github/workflows/pkgdown.yaml, I needed to add my dev branch called pkgdown_site.

I can take down from my github pages, because it's not my repo - but just wanted a live example for you guys to see. It would be awesome to have these up from the different R packages from the Azure team!

@mstackhouse
Copy link
Author

Just wanted to check in because this has been sitting stale for quite a while. I still use my self hosted package website for documentation reference, but if you guys don't want to merge the package website I can close the request out for you.

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.

2 participants