Skip to content

Commit

Permalink
generateReadme: Refresh
Browse files Browse the repository at this point in the history
  • Loading branch information
@actions-user
actions-user committed Oct 5, 2023
1 parent b427851 commit 7bca79e
Show file tree
Hide file tree
Showing 4 changed files with 160 additions and 116 deletions.
48 changes: 24 additions & 24 deletions .github/push_templates_to_algolia.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,10 @@
"id": "aa0e3e6f-1260-4452-8abf-7c084e26c8a4",
"metadata": {
"execution": {
"iopub.execute_input": "2023-10-05T07:18:00.270636Z",
"iopub.status.busy": "2023-10-05T07:18:00.270268Z",
"iopub.status.idle": "2023-10-05T07:18:00.324872Z",
"shell.execute_reply": "2023-10-05T07:18:00.323806Z"
"iopub.execute_input": "2023-10-05T16:42:52.722288Z",
"iopub.status.busy": "2023-10-05T16:42:52.721824Z",
"iopub.status.idle": "2023-10-05T16:42:52.780515Z",
"shell.execute_reply": "2023-10-05T16:42:52.779737Z"
},
"papermill": {},
"tags": []
Expand Down Expand Up @@ -95,10 +95,10 @@
"id": "cfa97168-63eb-4e8c-89c3-0a5d26f47740",
"metadata": {
"execution": {
"iopub.execute_input": "2023-10-05T07:18:00.327837Z",
"iopub.status.busy": "2023-10-05T07:18:00.327630Z",
"iopub.status.idle": "2023-10-05T07:18:00.332438Z",
"shell.execute_reply": "2023-10-05T07:18:00.331456Z"
"iopub.execute_input": "2023-10-05T16:42:52.784841Z",
"iopub.status.busy": "2023-10-05T16:42:52.784190Z",
"iopub.status.idle": "2023-10-05T16:42:52.788345Z",
"shell.execute_reply": "2023-10-05T16:42:52.787665Z"
},
"papermill": {},
"tags": []
Expand Down Expand Up @@ -141,10 +141,10 @@
"id": "7a9c86c2-931d-4113-abbc-31b3f517b6c4",
"metadata": {
"execution": {
"iopub.execute_input": "2023-10-05T07:18:00.335371Z",
"iopub.status.busy": "2023-10-05T07:18:00.335035Z",
"iopub.status.idle": "2023-10-05T07:18:00.349547Z",
"shell.execute_reply": "2023-10-05T07:18:00.348956Z"
"iopub.execute_input": "2023-10-05T16:42:52.791696Z",
"iopub.status.busy": "2023-10-05T16:42:52.791123Z",
"iopub.status.idle": "2023-10-05T16:42:52.806063Z",
"shell.execute_reply": "2023-10-05T16:42:52.805471Z"
},
"tags": []
},
Expand Down Expand Up @@ -178,10 +178,10 @@
"id": "c50e96b2-4403-413c-a99a-9243be0c0a04",
"metadata": {
"execution": {
"iopub.execute_input": "2023-10-05T07:18:00.352481Z",
"iopub.status.busy": "2023-10-05T07:18:00.351987Z",
"iopub.status.idle": "2023-10-05T07:18:00.971382Z",
"shell.execute_reply": "2023-10-05T07:18:00.970746Z"
"iopub.execute_input": "2023-10-05T16:42:52.809864Z",
"iopub.status.busy": "2023-10-05T16:42:52.809237Z",
"iopub.status.idle": "2023-10-05T16:42:53.660898Z",
"shell.execute_reply": "2023-10-05T16:42:53.659999Z"
},
"tags": []
},
Expand Down Expand Up @@ -230,10 +230,10 @@
"id": "da661ba3-fd15-4abc-bd4f-d13ae77b82b0",
"metadata": {
"execution": {
"iopub.execute_input": "2023-10-05T07:18:00.974671Z",
"iopub.status.busy": "2023-10-05T07:18:00.974251Z",
"iopub.status.idle": "2023-10-05T07:18:01.661416Z",
"shell.execute_reply": "2023-10-05T07:18:01.660799Z"
"iopub.execute_input": "2023-10-05T16:42:53.665166Z",
"iopub.status.busy": "2023-10-05T16:42:53.664433Z",
"iopub.status.idle": "2023-10-05T16:42:54.718952Z",
"shell.execute_reply": "2023-10-05T16:42:54.718221Z"
},
"tags": []
},
Expand All @@ -260,10 +260,10 @@
"id": "f1482a8f-4ce5-4e04-93c8-ddd883375d67",
"metadata": {
"execution": {
"iopub.execute_input": "2023-10-05T07:18:01.664574Z",
"iopub.status.busy": "2023-10-05T07:18:01.664054Z",
"iopub.status.idle": "2023-10-05T07:18:01.725852Z",
"shell.execute_reply": "2023-10-05T07:18:01.725262Z"
"iopub.execute_input": "2023-10-05T16:42:54.722805Z",
"iopub.status.busy": "2023-10-05T16:42:54.722327Z",
"iopub.status.idle": "2023-10-05T16:42:54.741716Z",
"shell.execute_reply": "2023-10-05T16:42:54.740993Z"
},
"tags": []
},
Expand Down
146 changes: 95 additions & 51 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,78 +1,122 @@
# Naas Templates [![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/sindresorhus/awesome)
# Naas Templates[![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/sindresorhus/awesome)
(aka the "awesome-notebooks")

## What is the objective of this repository ?
The objective of this repository is to create the largest catalog of production-ready Jupyter Notebooks templates. With those templates, it becomes easy to create data products (analytical dashboards, automation/AI engines and more).

## What is Naas ?

Naas is an all-in-one data platform that enable anyone with minimal technical knowledge to turn <a href="https://jupyter.org" target="_blank">Jupyter Notebooks</a> into powerful automation, analytical and AI data products thanks to <a href="https://docs.naas.ai/" target="_blank">low-code formulas</a> and microservices.<br>

The platform is based on 3 low-code layers:<br>
- **😎 Templates**: enable anyone to use data engines on all kind of subjects in minutes.
- **🏎 Drivers**: connectors to facilitate access to tools, and complex libraries (database, API, ML algorithm...)
- **🪐 Features**: production microservices on top of Jupyter like scheduling, asset sharing, notifications and more.<br>
Each of these templates adheres to a consistent framework, designed to expedite your coding process. While these templates are designed for ease of use, some may require data science skills for setup, particularly those that interface with third-party tools via API. These templates can function independently, but they also serve as integral components of data products. Consider them as the essential parts needed to assemble your 'car engine'. By developing these templates and ensuring their standalone functionality, we streamline the process of data product development, as we already comprehend the operation of some parts within it.

Naas Cloud is free to use with 100 credits/month.<br>
<a href="https://www.naas.ai/free-forever" target="_blank">Open your account</a><br>
All templates are readily accessible on [GitHub](https://github.com/jupyter-naas/awesome-notebooks) or via [Naas Search](https://naas.ai/search).

[>> More information](https://docs.naas.ai/)
![](https://site.naas.ai/assets/images/NaasSearch-1a3b28f814a61bfcbb1511997970a62d.gif)

## How is organized a template?

## What is the objective of this repository ?
To ensure the quality of the templates, we have defined a framework. Each notebook shall be organized as follow.

The objective of this repository is to create the largest catalog of production-ready Jupyter Notebooks templates. With those templates, it becomes easy to create data products (analytical dashboards, automation/AI engines and more). Check out the [data-product-template](https://github.com/jupyter-naas/data-product-template) repository to learn more.<br>
The repository is organized by source/tools for easy discovery. You can also use our ["Google-like" search](http://search.live.kn.naas.ai/) to find templates by keywords<br>
### Header

To ensure the quality of the templates, we have defined a framework. Each notebook shall be organized with the following sections:
- **Naas logo**
- **# Title**: "Tool - Action of the notebook", as h1. An "Open in Naas" button will be added automatically by the CI/CD when a notebook is merged to the master branch.
- **Tags:**: hashtags relevant to the topics covered in the notebook, as text
- **Author:**: name and social profile link of the author(s), as text
- **Last update:** YYYY-MM-DD (Created: YYYY-MM-DD): The last update date refers to when the notebook was last edited, while the created date corresponds to when the notebook was initially merged.
- **Description:**: a one-liner explaining the benefits of the notebooks for the user, as text
- **References:**: list of references and websites utilized in the creation of this notebook
- **Tags:** hashtags relevant to the topics covered in the notebook, as text
- **Author:** name and social profile link of the author(s), as text
- **Last update:** YYYY-MM-DD (Created: YYYY-MM-DD): The last update date refers to when the notebook was last edited, while the created date corresponds to when the notebook was initially merged.
- **Description:** a one-liner explaining the benefits of the notebooks for the user, as text
- **References:** list of references and websites utilized in the creation of this notebook

![](https://site.naas.ai/assets/images/Templates_Header-891c53c6f58b031412f54f2c47f3bf6b.PNG)

### Outline

- **## Input**: list of all the variables, credentials, that needs to be setup, as h2
- **## Model**: list the functions applied to the data, as h2
- **## Output**: list the assets to be used by the user and its distribution channels if any, as h2

![](https://site.naas.ai/assets/images/Templates_Outline-60c612f83174a61f9bd9d3d912dccc2b.PNG)

## How to contribute ?
## Providing Feedback

### Pre-requisites:
- Open free account on [Naas Cloud](https://www.naas.ai/free-forever) so we can test the templates in a similar environment
- Register to the [Contributor Program](https://form.typeform.com/to/jdls9qZf?typeform-source=www.naas.ai) so we can add you to team of contributors in the Naas GitHub organization
- Join our [Slack Community](https://join.slack.com/t/naas-club/shared_invite/zt-1970s5rie-dXXkigAdEJYc~LPdQIEaLA) so you can present yourself and #chat with us
At the top of the notebook, you'll find a link for providing feedback on the notebook you're using. This could be:

### Step by step process:
- A suggestion for a new feature that could enhance the notebook
- Documentation improvements to make it more user-friendly
- Notification of a typographical error
- A simple word of praise (🙂)

- **Step 1**: Find or propose an issue you want to work on
- The Backlog of the [Product Roadmap](https://github.com/orgs/jupyter-naas/projects/10) is where we put all the priorities
- The [Issues](https://github.com/jupyter-naas/awesome-notebooks/issues) section is where we gather all the needs
- **Step 2**: Prepare the issue before you start working on it
- Make sure the description is clear
- Tag yourself in Assignees section
- Change the status to 'In Progress' in Projects section/Community Roadmap
- Create a branch in Development section
- **Step 3**: Clone the awesome-notebooks repository on your Naas Cloud account and switch to the branch you created
- **Step 4**: Create folder named with the source tool (if it's not already created)
- **Step 5**: Copy/Paste template.ipynb at the root of the folder inside the folder you are working on, and start working on your notebook
- **Step 6**: Once you are happy with the result, commit to the branch by using Git extension or command line (make sure you use a GitHub personal access token and not password, otherwise it wont work)
- **Step 7**: Open a Pull Request and add a member of the core team as Reviewer ([Florent](https://github.com/FlorentLvr),[Maxime](https://github.com/Dr0p42) or [Jeremy](https://github.com/jravenel))
- **Step 8**: Change status of this Issue to “Review” in Projects section and comment the Pull Request with a brief on what you have done
- **Step 9**: Expect a feedback and merge in the next 48h-72h
- **Step 10**: Once merged, promote your work on LinkedIn, Twitter and other social media channels! (Optional, but people need to know you are awesome 😉)
Upon clicking this link, you'll be redirected to a Google form where you can provide more information. We will endeavor to contact the notebook creator for improvements or seek community assistance during our bi-monthly community calls that aim to create new templates or enhance existing ones.

[>> More information](https://docs.naas.ai/contributing-to-naas)
![](https://site.naas.ai/assets/images/Templates_GiveFeedback-0b6357200a2e2ffb4dfd6d4d451b2f57.PNG)

## Reporting A Bug

## Support on social media
We are committed to sharing templates and giving shout outs to the contributors on our social media platforms, you can support us on:
- [Twitter](https://twitter.com/JupyterNaas) for fast updates<br>
- [LinkedIn](https://www.linkedin.com/company/naas-ai/) for more elaborated posts and articles<br>
- [Youtube](https://www.youtube.com/channel/UCKKG5hzjXXU_rRdHHWQ8JHQ/videos) for demos and tutorials<br>
Since all our templates are open-source, errors may occasionally occur. We apologize for any inconvenience that may cause and request your support in reporting these issues to help us rectify them. To report a bug, click on the link at the top of the notebook. You will be redirected to GitHub to create an issue. Please attach screenshots to help us understand the bug, and provide any other information that could assist us in reproducing the issue. We will strive to respond as quickly as possible to resolve the issue.

![](https://site.naas.ai/assets/images/Templates_BugReport-9005de95d2490678d263e65ed41b59e7.PNG)

## How to contribute?

### Pre-requisites
- Register for the [Open Source Contributor Program](https://forms.gle/bfCBi8jRFFpapxNP6) so we can add you to the team of contributors in the Naas GitHub organization. To start working on our repository, you must be a part of our [open-source contributors team](https://github.com/orgs/jupyter-naas/teams/opensource-contributors). Please check your email and validate the invitation before you begin working on a new issue.
- Create your [GitHub personal access token](https://github.com/settings/tokens). Select “No expiration” and tick only the first section repository and keep your token safe as you won’t be able to generate it again.
- Open a [free account on Naas Lab](https://app.naas.ai/) so we can test the templates in a similar environment.

### Step 1: Create or Select an Issue

Identify or propose an issue you wish to work on. It could be a snippet of Python code, an API integration with a tool you are using, or an automation leveraging existing templates with our scheduler, asset, or webhook features. Before you begin working on it, prepare the issue:

- Ensure the description is clear.
- Tag yourself in the Assignees section.
- Change the status to 'In Progress' in the Projects section/Community Roadmap.
- Create a branch in the Development section.

### Step 2: Technical Setup

Clone the awesome-notebooks repository on your Naas Cloud account and switch to the branch you created.
If a draft of a template (generated with our AI system) has been already created, you can directly start working on it.

# Template analytics
Otherwise, you kick start manually:
- Create a folder named with the source tool (if it's not already created).
- Copy and paste template.ipynb at the root of the repository and start working on your notebook.

### Step 3: Work on Your Notebook

Start working on your notebook. Commit your work every time you make significant progress. You can use the UI interface inside your Naas Lab server to do this.

- All new files will be found in the untracked section, all modified files in the unstaged section.
- Once you want to commit, add your notebook to staged by clicking on the + and create a commit message. We recommend following the commit convention and starting your message with “feat:” if it's an improvement or “fix:” if it's a bug fix, followed by a clear commit message. Here are some examples:
- feat: update tags, author, and description
- feat: developing function in model to…
- fix: adding try except to manage error on…
- Once you're satisfied with the result, push to the branch by clicking on the icon on top (make sure you use a GitHub personal access token and not a password, otherwise, it won’t work).
- Ensure the notebook respects the framework.

### Step 4: Open a Pull Request

Open a Pull Request and add a core team member as Reviewer (Florent, Maxime, or Jeremy).

- Change the status of this Issue to “Review” in the Projects section and comment on the Pull Request with a brief summary of what you've done.
- You will now discuss your work on the PR. If any changes are made, ensure you pull the branch before working on it again by clicking on the button at the top.
- Expect feedback and merge within the next 48-72 hours.

### Step 5: Promote Your Work

Once merged, promote your work on LinkedIn, Twitter, and other social media channels! (Optional, but people need to know you are awesome 😉). Explain why you did this notebook and how it could be useful. You can use the certificate generated once the PR is merged to display your work and add the tag open source contributor on your LinkedIn profile. We will be happy to have you in our community.

Thank you!

### Step 6: Become a Templates Maintainer

If you want to contribute more frequently to Naas, you can become a templates maintainer. This status will offer you the right to be sponsored by Naas for your contributions done every month, ranging from $50 to $250. To become a templates maintainer, you must have completed at least 5 notebooks (which ensures you've mastered our process) and created 5 social media content promoting your template or Naas.

Then, you will be introduced to our template maintainer program and will have a dedicated team with the core team to assist you in developing integrations, automations, or AI systems.

## Support us on social media

We are committed to sharing templates and giving shout outs to the contributors on our social media platforms, you can support us on:

![Templates_monthly](https://public.naas.ai/bWV0cmljcy00MG5hYXMtMkVhaQ==/asset/09d0bd9ed8ac2479a2a4f05e60c74d101d140ffdfacd9b0ac7bbb4e53966.png)
- [Twitter](https://twitter.com/JupyterNaas) for fast updates
- [LinkedIn](https://www.linkedin.com/company/naas-ai/) for more elaborated posts and articles
- [Youtube](https://www.youtube.com/channel/UCKKG5hzjXXU_rRdHHWQ8JHQ/videos) for demos and tutorials

# Templates list

Expand Down
Loading

0 comments on commit 7bca79e

Please sign in to comment.