From d4394a395bd5dd4543f0240f7c2e08f98a53bd1f Mon Sep 17 00:00:00 2001 From: Stefan Krawczyk Date: Fri, 10 Nov 2023 20:54:07 -0800 Subject: [PATCH] Adjusts hub wording and initial post I have set the post into the future, and adjusted wording for it and on the general README. --- contrib/docs/blog/2023-09-21-welcome/index.md | 23 -------------- contrib/docs/blog/2023-11-13-welcome/index.md | 31 +++++++++++++++++++ contrib/docs/docs/README.md | 4 +-- 3 files changed, 33 insertions(+), 25 deletions(-) delete mode 100644 contrib/docs/blog/2023-09-21-welcome/index.md create mode 100644 contrib/docs/blog/2023-11-13-welcome/index.md diff --git a/contrib/docs/blog/2023-09-21-welcome/index.md b/contrib/docs/blog/2023-09-21-welcome/index.md deleted file mode 100644 index 859af801d..000000000 --- a/contrib/docs/blog/2023-09-21-welcome/index.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -slug: welcome -title: Welcome -authors: [skrawcz] -tags: [hamilton, how-to, dataflows] ---- - -Welcome to the Hamilton Dataflow Hub! - -We're excited to kick off this project and hope that it will be a useful resource for the community. -Hamilton is like a Swiss army knife, it's very versatile, as you can use it for data, ML, LLM, and web work! - -We envision this hub, as a place to share the flows you've built with it that can be useful to others! - -## How to use - -1. Browse the dataflows defined. -2. Find a dataflow you want to use. -3. Cut and paste the code snippet to get started with it! - -## How to contribute - -Head on over to [github and read the instructions](https://github.com/DAGWorks-Inc/hamilton/tree/user_contrib/contrib#how-to-contribute). diff --git a/contrib/docs/blog/2023-11-13-welcome/index.md b/contrib/docs/blog/2023-11-13-welcome/index.md new file mode 100644 index 000000000..939c5f939 --- /dev/null +++ b/contrib/docs/blog/2023-11-13-welcome/index.md @@ -0,0 +1,31 @@ +--- +slug: hub-launch-welcome +title: 🚀 Welcome to the Hamilton Hub +authors: [skrawcz] +tags: [hamilton, how-to, dataflows] +--- + +Welcome to the Hamilton Dataflow Hub! + +We're excited to kick off this project and hope that it will be a useful resource for the community. +Hamilton is like a Swiss army knife, it's very versatile, as you can use it for data, ML, LLM, and web work! + +We envision this hub, as a place to share the flows you've built that can be useful to others! As well as a place +for you to find flows that others have built that you can use and easily modify for your work! + +## How to use + +1. Browse the dataflows defined. +2. Find a [dataflow](/docs) you want to use. +3. Cut and paste the code snippet to get started with it! +4. Use the dataflow as is, or modify it to your needs by copying it to your own repository via [copy()](https://hamilton.dagworks.io/en/latest/reference/dataflows/copy/). + +## How to contribute + +We're excited to have you contribute to the Hamilton Dataflow Hub! + +Head on over to [github and read the instructions](https://github.com/DAGWorks-Inc/hamilton/tree/main/contrib#how-to-contribute). + +If you have questions, join us on [slack](https://join.slack.com/t/hamilton-opensource/shared_invite/zt-1bjs72asx-wcUTgH7q7QX1igiQ5bbdcg). + +## 🙏 diff --git a/contrib/docs/docs/README.md b/contrib/docs/docs/README.md index cb84d0317..76fe1cb07 100644 --- a/contrib/docs/docs/README.md +++ b/contrib/docs/docs/README.md @@ -16,9 +16,9 @@ will move them into the official DAGWorks sub-package of this site and become ma DAGWorks's Hamilton team. ## Navigation -☝️ Above you'll find a search bar to help you find what you're looking for. +☝️ Use the search bar above to quickly find dataflows based on keyword search. -👈 On the left hand you'll have the ability to find _User_ and _DAGWorks_ maintained dataflows. +👈 On the left hand can find dataflows organized by _User_, _DAGWorks_, and tags. ## Usage