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

vignette for board_url() #692

Merged
merged 21 commits into from
Jan 20, 2023
Merged

vignette for board_url() #692

merged 21 commits into from
Jan 20, 2023

Conversation

ijlyttle
Copy link
Contributor

fix #685

@juliasilge - just to let you know I'm working on this, and to give you an early opportunity to point me back to the right path, if need be.

@juliasilge
Copy link
Member

This looks good so far! I would probably do "Publishing" before "Consuming".

@ijlyttle
Copy link
Contributor Author

ijlyttle commented Dec 17, 2022

My first thought was there would be more consumers than publishers, but I agree with you; it would make the programming a whole lot more convoluted.

@ijlyttle
Copy link
Contributor Author

@juliasilge - non-urgent question for you:

I'm failing the R-CMD-check-hard workflow because webfakes is not a hard dependency. I don't know if the right move is to make it a hard dependency, or instead to add it to the workflow's extra-packages:.

Thanks!

@ijlyttle
Copy link
Contributor Author

ijlyttle commented Dec 18, 2022

You left the answer in the other vignette 😅

@ijlyttle
Copy link
Contributor Author

I think I've got this to a "discussable" point; the sections on publishing and consuming are ready for review.

There's an additional section on platforms. I wanted to create examples for Quarto and pkgdown, if for no other reason than to demonstrate clearly to myself that it works. A couple points here:

  • I don't know if you will want to include the links in the vignette, as it adds a bit of risk: I could absent-mindedly delete the repos, or repurpose them to advertise sports-betting :). That being the case, I'd be happy to turn the repos over to you all, or find another way to accomplish the goal.
  • I found something in Quarto that I'd like to clear up before merging this vignette: I don't quite understand how it handles external resources. I'm sure this won't take too long.

I also created a section for S3, but I don't have an S3 account. From what I read, it should just work™️ to publish your bucket as a website.

Thanks!

Copy link
Member

@juliasilge juliasilge left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is looking great! 🙌 I made a few minor suggestions in the narrative.

I see that we're waiting on something from the Quarto folks to get that squared away. 👍

I see what you mean about those nice example repos you created. Hmmm... Let's keep them there for now, unless we decide there is something better suited for them.

vignettes/using-board-url.Rmd Outdated Show resolved Hide resolved
vignettes/using-board-url.Rmd Outdated Show resolved Hide resolved
vignettes/using-board-url.Rmd Outdated Show resolved Hide resolved
ijlyttle and others added 3 commits January 9, 2023 13:42
incorporate suggestion

Co-authored-by: Julia Silge <julia.silge@gmail.com>
incorporate suggestion

Co-authored-by: Julia Silge <julia.silge@gmail.com>
incorporate suggestion 😅

Co-authored-by: Julia Silge <julia.silge@gmail.com>
@ijlyttle
Copy link
Contributor Author

ijlyttle commented Jan 9, 2023

Hi @juliasilge - thanks for your feedback and patience, we're getting there!

I agree that we should let the Quarto folks sort things out, and leave the demo repos where they are until a better solution presents itself.

Hopefully be back soon!

@juliasilge
Copy link
Member

@ijlyttle I think we want to move forward with a pins release fairly expediently, so my plan here is to remove the Quarto section of this vignette and open an issue to add that back in later, when the change is made in Quarto. I'll take a stab at finishing up this vignette!

@ijlyttle
Copy link
Contributor Author

ijlyttle commented Jan 19, 2023

Sounds good - hopefully everything gets worked out soon! Please let me know if I can help.

I have removed the "draft" label, in case that clears a road-block.

@juliasilge
Copy link
Member

@ijlyttle Would you mind looking over my edits to see if any changes I made don't make sense? Give it one more look before I merge?

@ijlyttle
Copy link
Contributor Author

Hi @juliasilge, it looks great - much improved, in fact!

Thanks!

@juliasilge juliasilge merged commit 2e6dfbf into rstudio:main Jan 20, 2023
@ijlyttle ijlyttle deleted the doc-685-manifest branch January 20, 2023 02:53
@github-actions
Copy link

github-actions bot commented Feb 4, 2023

This pull request has been automatically locked. If you believe you have found a related problem, please file a new issue (with a reprex: https://reprex.tidyverse.org) and link to this issue.

@github-actions github-actions bot locked and limited conversation to collaborators Feb 4, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add new vignette about using manifest + board_url()
2 participants