Add examples within the docs/
#88
Conversation
|
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. |
alvarobartt
changed the title
examples within the docs/examples within the docs/
alvarobartt
force-pushed
the
add-notebooks-to-docs
branch
from
02b52ca to
058dab0
Compare
Co-authored-by: Jeff Boudier <[email protected]>
Co-authored-by: Philipp Schmid <[email protected]>
Remove Jupyter Markdown comment to hide the metadata after its converted from `.ipynb` to `.mdx`
As those are automatically generated and not intended to be pushed
alvarobartt
changed the title
examples within the docs/examples within the docs/
| - [Serve Gemma open models using GPUs on GKE with Hugging Face TGI](https://cloud.google.com/kubernetes-engine/docs/tutorials/serve-gemma-gpu-tgi) | ||
| - [Generative AI on Vertex - Use Hugging Face text generation models](https://cloud.google.com/vertex-ai/generative-ai/docs/open-models/use-hugging-face-models) | ||
|
|
||
| ## Examples |
There was a problem hiding this comment.
I think we can remove this part now it's available on the left side navigation bar?
There was a problem hiding this comment.
I think we can keep it, if it is automatic updated.
There was a problem hiding this comment.
IMO we should remove even if automatically updated:
- We have too many links on this page which impacts bounce rate (so far 1 out of 500 exit page are one of those links, and its a blogpost, not an example)
- It's the same as what we have on the left side navigation menu
There was a problem hiding this comment.
On your other argument on SEO @philschmid, you know better than me what works and what not. I would have thought that the separated page for each example is what you want to be at the top of Google results rather than the docs/source/resources.mdx page.
There was a problem hiding this comment.
that's great!
2 feedbacks:
- Would be good to define standards in example names for easier discoverability
- I think we could separate better how to deploy from the Hub, from the Model Garden in GCP and from a notebook. I don't want to mix this in this PR, so i'll make a suggestion once this PR is merged.
I would keep it if automated. As it might be better for SEO. Its always good to have a full overview. |
|
Thank you for the review @philschmid and @pagezyhf! So for the examples and containers listing I want to start moving some scripts I use locally into a separate GitHub Action so that those are automatically generated yes. In this case, for the "additional" example listing I think we can keep it, but I don't know much about best SEO practices either. |
Co-authored-by: pagezyhf <[email protected]>
- Add missing `--shm-size 1g` - Fixed some wording / typos
Description
This PR adds the
examplesto the https://hf.co/docs/google-cloud documentation, so as to add more content there.