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

Add Quarto Space docs #1226

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Add Quarto Space docs #1226

wants to merge 6 commits into from

Conversation

gshotwell
Copy link
Contributor

This adds documentation for the Quarto space template .

@osanseviero

@HuggingFaceDocBuilderDev

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

Copy link
Contributor

@osanseviero osanseviero left a comment

Choose a reason for hiding this comment

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

Very exciting!

docs/hub/_toctree.yml Outdated Show resolved Hide resolved
docs/hub/spaces-sdks-docker-quarto.md Outdated Show resolved Hide resolved
docs/hub/spaces-sdks-docker-quarto.md Outdated Show resolved Hide resolved
Comment on lines 8 to 10
1. Create the Quarto space, and clone it locally

<a href="https://huggingface.co/new-space?template=posit/quarto-template"> <img src="https://huggingface.co/datasets/huggingface/badges/raw/main/deploy-to-spaces-lg.svg"/> </a>
Copy link
Contributor

Choose a reason for hiding this comment

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

I would split this into two steps, and I think you should add an example code snippet on how to clone the repo

Copy link
Contributor

Choose a reason for hiding this comment

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

Actually, cloning locally is not a strict requirement no? People can do the development entirely in the UI. I would suggest to split this into

  • Creating and setting up the repo, doing changes in the Space by directly modifying /src
  • Developing locally (install quarto, VS Code extension)
  • Learn more about Quarto

Copy link
Contributor Author

@gshotwell gshotwell Mar 6, 2024

Choose a reason for hiding this comment

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

I suppose that's true, but working on a quarto site in the browser without being able to preview the site would likely be pretty awkward. Happy to change the organization though.

Copy link
Contributor

Choose a reason for hiding this comment

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

I think mentioning, even if briefly, the in-browser setup could be ok!

docs/hub/spaces-sdks-docker-quarto.md Outdated Show resolved Hide resolved
docs/hub/spaces-sdks-docker-quarto.md Outdated Show resolved Hide resolved
docs/hub/spaces-sdks-docker-quarto.md Outdated Show resolved Hide resolved
Copy link
Member

@pcuenca pcuenca left a comment

Choose a reason for hiding this comment

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

Looking good, thanks a lot!

docs/hub/spaces-sdks-docker-quarto.md Outdated Show resolved Hide resolved
docs/hub/spaces-sdks-docker-quarto.md Show resolved Hide resolved
docs/hub/spaces-sdks-docker-quarto.md Outdated Show resolved Hide resolved

2. Clone the Repo

To clone the space locally run the following command, make sure to replace `<YOUR_HF_USER>` with your Hugging Face username.
Copy link
Member

Choose a reason for hiding this comment

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

They might need to be logged in if the Space is private.

docs/hub/spaces-sdks-docker-quarto.md Outdated Show resolved Hide resolved
docs/hub/spaces-sdks-docker-quarto.md Outdated Show resolved Hide resolved
docs/hub/spaces-sdks-docker-quarto.md Show resolved Hide resolved
Gordon Shotwell and others added 2 commits March 7, 2024 09:44
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.

4 participants