Feat: Notebook for data sharing #22088
Conversation
|
Hi @cbehera-newrelic 👋 Thanks for your pull request! Your PR is in a queue, and a writer will take a look soon. We generally publish small edits within one business day, and larger edits within three days. Please ensure the propsed changes look good by building it first in your local environment. Refer to this contribution guide to get the site up and running in your local. If you really require a preview url, reach out to one of the writers and they will generate one for you. |
|
netlify build |
🚀 Netlify Preview Building!If the build is successful, the preview for this pull request will be available at the following URL (usually takes 10-20 minutes): https://notebooks-for-data--docs-website-netlify.netlify.app |
|
netlify build |
cbehera-newrelic
added
content
|
|
||
| ### Organization association | ||
|
|
||
| Every notebook is a resource that belongs to the organization in which it was created. This association is permanent. If the organization is deleted, the notebook is deleted as well. |
There was a problem hiding this comment.
Can a notebook be moved between orgs or shared?
| ### Current permissions model | ||
|
|
||
| <Callout variant="tip"> | ||
| Notebooks currently do not have granular permission settings. Anyone in the organization who has access to the feature can create new notebooks, edit and delete existing ones. We are working on introducing granular permissions allowing users to decide who within the organization sees, edits and deletes particular notebooks. |
There was a problem hiding this comment.
Do not mention what features we are working on for the future.
| * All organization members with notebooks access can create, edit, and delete any notebook | ||
| * Notebooks are automatically shared across your entire organization | ||
|
|
||
| **Coming soon:** |
|
|
||
| 1. Go to **[one.newrelic.com](https://one.newrelic.com)**. | ||
| 2. Open the **Query your data** console from the drawer at the bottom of the page. | ||
| 3. Click on **Notebooks** in the query builder header to see a list of all notebooks created by your organization. |
There was a problem hiding this comment.
We never say "click on" for anything. There another instance in this article where u use this construct. It is always just "click"
|
|
||
| ### Start from the notebooks index | ||
|
|
||
| 1. Select the **+ Create a notebook** button at the top-right corner of the index. |
There was a problem hiding this comment.
You cannot select a button. You always click it.
|
|
||
| 1. Select the **+ Create a notebook** button at the top-right corner of the index. | ||
| 2. Give your notebook a meaningful name (names are searchable, so use relevant keywords like your service or application name). | ||
| 3. Press **Create**. |
There was a problem hiding this comment.
What is Press? C'mon Chinmay.....focus man
| 1. Select the **+ Create a notebook** button at the top-right corner of the index. | ||
| 2. Give your notebook a meaningful name (names are searchable, so use relevant keywords like your service or application name). | ||
| 3. Press **Create**. | ||
| 4. The query console drawer opens. Type your first query! |
|
|
||
| 1. Open the query console (the drawer at the bottom of the platform). | ||
| 2. Create your desired queries and Markdown blocks. | ||
| 3. Press the **Save** button. |
There was a problem hiding this comment.
Review all your procedures for actions on UI elements. These don't follow style guide recommendations.
| title="Manage your notebooks" | ||
| > | ||
|
|
||
| ### Search and sort notebooks |
There was a problem hiding this comment.
Do we need this? This is regular behavior. Why are we writing about it unless there is something special here.
| * Favorites (starred notebooks appear first) | ||
| 3. **Filter by favorites**: Click the star filter to show only your favorite notebooks. | ||
|
|
||
| ### Duplicate a notebook |
There was a problem hiding this comment.
When u duplicate a notebook, does it ask for org information or anything? Is it duplicated in the same org as the orginal one? What is the benefit? I am guessing we should approach this from the angle of templates.
| title="Delete a notebook" | ||
| > | ||
|
|
||
| <Callout variant="caution"> |
There was a problem hiding this comment.
Can a deleted notebook be retrieved?
|
|
||
| Queries coming from Data Explorer are added to the active block if the active block is of type query. If the active block is currently markdown, a new query block is added. | ||
|
|
||
| To change an active block you need to select or add another block in the notebook. |
There was a problem hiding this comment.
What does this mean? Not sure what we are trying to say here?
Also, how do you make a block "not active"?
|
|
||
| To change an active block you need to select or add another block in the notebook. | ||
|
|
||
| When a Markdown Block is active, it automatically enters an editing mode featuring a convenient two-column layout to optimize your documentation workflow: |
There was a problem hiding this comment.
| When a Markdown Block is active, it automatically enters an editing mode featuring a convenient two-column layout to optimize your documentation workflow: | |
| When a Markdown Block is active, it automatically enters editing mode featuring a two-column layout: |
| To change an active block you need to select or add another block in the notebook. | ||
|
|
||
| When a Markdown Block is active, it automatically enters an editing mode featuring a convenient two-column layout to optimize your documentation workflow: | ||
| * **Editing Column (Left)**: This is where you directly type and format your Markdown code. |
There was a problem hiding this comment.
| * **Editing Column (Left)**: This is where you directly type and format your Markdown code. | |
| * **Editing Column (Left)**: This is where you type and format your Markdown code. |
|
|
||
| When a Markdown Block is active, it automatically enters an editing mode featuring a convenient two-column layout to optimize your documentation workflow: | ||
| * **Editing Column (Left)**: This is where you directly type and format your Markdown code. | ||
| * **Live Preview Column (Right)**: This instantly displays a real-time visual preview of your formatted documentation, ensuring accuracy as you type. |
There was a problem hiding this comment.
| * **Live Preview Column (Right)**: This instantly displays a real-time visual preview of your formatted documentation, ensuring accuracy as you type. | |
| * **Live Preview Column (Right)**: This displays a real-time visual preview of your formatted documentation. |
|
|
||
| ## Action toolbar | ||
|
|
||
| To help you optimize your workspace and maintain a clean view, the notebooks interface features an action toolbar. It consolidates core query actions into a compact, icon-based menu and groups secondary controls into a dedicated Actions Menu. |
There was a problem hiding this comment.
Delete this. No valuable information here.
|
|
||
| ### Core actions (Top of the Query block) | ||
|
|
||
| These essential, frequently used actions are directly accessible at the top of the query block via intuitive icons: |
There was a problem hiding this comment.
| These essential, frequently used actions are directly accessible at the top of the query block via intuitive icons: | |
| These essential, frequently used actions are accessible at the top of the query block: |
|
|
||
| These essential, frequently used actions are directly accessible at the top of the query block via intuitive icons: | ||
| * **Run query**: This is now represented by a play icon and executes the current query. | ||
| * **Recent queries**: Allows you to quickly access and reuse recently executed queries. |
There was a problem hiding this comment.
How many queries will it list out? How do we define "recent".....by number or by days?
|
|
||
| ### Actions Menu (Secondary controls) | ||
|
|
||
| The Actions Menu houses additional, less frequently used, or organizational controls to keep your main toolbar uncluttered. |
There was a problem hiding this comment.
"houses" will not translate properly.
| The Actions Menu houses additional, less frequently used, or organizational controls to keep your main toolbar uncluttered. | |
| The Actions Menu houses additional, less frequently used, or organizational controls. |
| * **PromQL translator**: A utility for translating queries into PromQL (Prometheus Query Language). | ||
| * **Clear**: Removes the query from the query input. | ||
| * **Create alert**: Initiates the process for setting up a new alert based on the query results. | ||
| * **Move up/down/to the top/to the bottom**: Reorganizes the current query block's position within the notebook. |
There was a problem hiding this comment.
Why is this useful? Do the queries run in sequence?
| To add a query block to your notebook: | ||
|
|
||
| 1. Open your notebook in the query console. | ||
| 2. Click the **+ Query** button or press **Ctrl+Enter** (or **Cmd+Enter** on Mac) to add a new query block. |
There was a problem hiding this comment.
We never say "click the blah button".....just "click blah"
| title="Duplicate a query block" | ||
| > | ||
|
|
||
| 1. Hover over the query block. |
There was a problem hiding this comment.
Not hover...."place your mouse pointer"
Create a public preview documentation for Notebooks feature