Closed ahuang11 closed 1 year ago
I like this idea of having GitHub Pages! Just a few suggestions:
I would prefer to keep all of the recipes searchable/visible on the README. I know in collections there is no link to the GitHub Pages as it's meant to be accessed via the Prefect Docs, right? But I want anyone to find the recipes repo and have all the recipes at their fingertips. Only other thing I can think of is that there is a broken image on the README if you move the Chef Marvin image.
With those little changes I think this would be good to go! Thanks a lot for putting this together :)
I know in collections there is no link to the GitHub Pages as it's meant to be accessed via the Prefect Docs, right?
Do you mean this?
I know in collections there is no link to the GitHub Pages as it's meant to be accessed via the Prefect Docs, right?
Do you mean this?
Ah, I hadn't noticed that. Can you just ensure that a) the recipes remain on the readme for now b) the Chef Marvin link isn't broken on the readme
If you disagree, we can discuss :)
Sounds good to me.
I also wonder if there's a way to improve visibility for docs link.
Description
Start the migration to GitHub pages.
Here's what it looks like locally with
mkdocs serve
Here's the one section I moved; could be more granular if we have more recipes
Eventually, I imagine these can be labeled with Collection tags like:
But instead of Experimental, can be (Ray, Dask, Azure, AWS, GCP etc)
Since I don't have Maintainer's permissions, I can't start the GitHub pages, but following these instructions will publish it: "Upon publishing, a docs branch is automatically created. To hook this up to GitHub Pages, simply head over to https://github.com/PrefectHQ/prefect-recipes/settings/pages, select docs under the dropdown menu, keep the default /root folder, Save, and upon refresh, you should see a prompt stating "Your site is published at https://prefecthq.github.io/prefect-recipes". Don't forget to add this link to the repo's "About" section, under "Website" so users can access the docs easily."
Type of change
New Recipe Checklist
Add <project-name> recipe