New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add content for new notebook page #27382

Merged

dd-mergequeue merged 5 commits into master from esther/docs-9825-notebooks-mvp

Feb 3, 2025

Contributor

estherk15 commented Jan 30, 2025 •

edited by jira bot

Loading

What does this PR do? What is the motivation?

The Notebooks product is undergoing a revamp and will be available in Preview next Wednesday

This is an MVP documentation, a lot of the content is copied over from legacy docs.
There are plans to break this information up, to clean up structure, and to add more images. But this is the MVP so product engineering can send this to prospective customers for content.
Editorial Review: DOCS-9979

Merge instructions

Merge readiness:

Ready for merge

Merge queue is enabled in this repo. To have it automatically merged after it receives the required reviews, create the PR (from a branch that follows the <yourname>/description naming convention) and then add the following PR comment:

/merge

Additional notes


          Add content for new notebook page

cc6d99a

estherk15 requested review from a team as code owners

January 30, 2025 21:18

github-actions bot added Architecture Images labels

Contributor

github-actions bot commented Jan 30, 2025

Preview links (active after the `build_preview` check completes)

New or renamed files

Modified Files

https://docs-staging.datadoghq.com/esther/docs-9825-notebooks-mvp/notebooks/

estherk15 added the editorial review label

estherk15 added 2 commits

January 30, 2025 19:05


          Add other graph types that product plans to support end of Feb

4c973ec


          Change default to the new notebooks page

656a6de

janine-c reviewed

View reviewed changes

Contributor

janine-c left a comment

This was a beast, Esther, nicely done! I made some copyedit and formatting suggestions - don't hesitate to let me know if you'd like to chat about any of them, if you'd like me to take another look, or any other way I can help 😀

content/en/notebooks/notebooks_legacy.md


		## Overview

		Notebooks combine graphs and text in a linear, cell-based format. They help you explore and share stories with your data by creating postmortems, investigations, runbooks, documentation, and more.

Contributor

janine-c Jan 31, 2025

I know this is existing content, so I won't spend too much time on it 🙂 This phrasing gave me pause for a sec, though, because it made it sound like we were telling people to tell stories to their data 😂

Suggested change

      
            Notebooks combine graphs and text in a linear, cell-based format. They help you explore and share stories with your data by creating postmortems, investigations, runbooks, documentation, and more.
          
            Notebooks combine graphs and text in a linear, cell-based format. They help you explore and create stories with your data, using postmortems, investigations, runbooks, documentation, and more.

content/en/notebooks/notebooks_legacy.md

Comment on lines +59 to +65

+              You can switch between modes from within the Notebook by selecting the dropdown at the top right of your notebook.
+              - **Editing**: make changes to the notebook.
+              - **Viewing**: contents are Read Only, preventing users from making unwanted edits to existing configurations and information.
+              - **Presenting**: share the contents of the Notebook in a display format where each cell appears as a slide. Presentation mode supports graph interactions such as tooltips and legends.

Contributor

janine-c Jan 31, 2025

Suggested change

      
            You can switch between modes from within the Notebook by selecting the dropdown at the top right of your notebook.
          
            - **Editing**: make changes to the notebook.
          
            - **Viewing**: contents are Read Only, preventing users from making unwanted edits to existing configurations and information.
          
            - **Presenting**: share the contents of the Notebook in a display format where each cell appears as a slide. Presentation mode supports graph interactions such as tooltips and legends.
          
            You can switch between modes from within the notebook by selecting the dropdown at the top right of your notebook.
          
            - **Editing**: make changes to the notebook.
          
            - **Viewing**: contents are Read Only, preventing users from making unwanted edits to existing configurations and information.
          
            - **Presenting**: share the contents of the notebook in a display format where each cell appears as a slide. Presentation mode supports graph interactions such as tooltips and legends.

content/en/notebooks/notebooks_legacy.md

+              * **All Notebooks**: All Notebooks in your organization.
+              * **[Notebook Type](#notebook-types)**: Group notebooks by type.
+              Hover over the Preview icon for any Notebook to see a preview of the contents, including widget types and Markdown. To open the Notebook in [View Mode](#view-mode), hover over the notebook and click **Open notebook in view mode** on the right.

Contributor

janine-c Jan 31, 2025

Suggested change

      
            Hover over the Preview icon for any Notebook to see a preview of the contents, including widget types and Markdown. To open the Notebook in [View Mode](#view-mode), hover over the notebook and click **Open notebook in view mode** on the right.
          
            Hover over the Preview icon for any notebook to see a preview of the contents, including widget types and Markdown. To open the notebook in [View Mode](#view-mode), hover over the notebook and click **Open notebook in view mode** on the right.

content/en/notebooks/notebooks_legacy.md


		### Notebook types

		{{< img src="notebooks/add_notebook_type.png" alt="Add Type button highlighted in a Notebook" style="width:100%;">}}

Contributor

janine-c Jan 31, 2025

Suggested change

      
            {{< img src="notebooks/add_notebook_type.png" alt="Add Type button highlighted in a Notebook" style="width:100%;">}}
          
            {{< img src="notebooks/add_notebook_type.png" alt="Add Type button highlighted in a notebook" style="width:100%;">}}

content/en/notebooks/notebooks_legacy.md


		#### Layout options

		In a Notebook cell, click Edit to view the cell configuration in edit mode. You can also see the available layout options, which vary based on the cell content type, but include the following:

Contributor

janine-c Jan 31, 2025

Suggested change

      
            In a Notebook cell, click **Edit** to view the cell configuration in edit mode. You can also see the available layout options, which vary based on the cell content type, but include the following:
          
            In a notebook cell, click **Edit** to view the cell configuration in edit mode. You can also see the available layout options, which vary based on the cell content type, but include the following:

content/en/notebooks/notebooks_new.md Outdated Show resolved Hide resolved

content/en/notebooks/notebooks_new.md Outdated Show resolved Hide resolved

content/en/notebooks/notebooks_new.md Outdated Show resolved Hide resolved

content/en/notebooks/notebooks_new.md Outdated Show resolved Hide resolved

content/en/notebooks/notebooks_new.md Outdated Show resolved Hide resolved


          Apply suggestions from code review

044d4d4

Co-authored-by: Janine Chan <[email protected]>

janine-c approved these changes

View reviewed changes


          reverse the tab ordering

0fc40d6

StefonSimmons approved these changes

View reviewed changes

Contributor Author

estherk15 commented Feb 3, 2025

/merge

dd-devflow bot commented Feb 3, 2025 •

edited

Loading

Devflow running: `/merge`

View all feedbacks in Devflow UI.

2025-02-03 20:34:27 UTC ℹ️ MergeQueue: pull request added to the queue

The median merge time in master is 7m.

2025-02-03 20:41:22 UTC ℹ️ MergeQueue: This merge request was merged

dd-devflow bot added mergequeue-status: queued mergequeue-status: in_progress and removed mergequeue-status: queued labels

dd-mergequeue bot merged commit 5a7b98f into master

19 checks passed

dd-mergequeue bot deleted the esther/docs-9825-notebooks-mvp branch

February 3, 2025 20:41

dd-devflow bot added mergequeue-status: done and removed mergequeue-status: in_progress labels

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Architecture editorial review Images mergequeue-status: done