Skip to content
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.

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

Added content based on Ximena's recommendations. #28679

Closed
wants to merge 3 commits into from

Conversation

achatterjee-grafana
Copy link
Contributor

@achatterjee-grafana achatterjee-grafana commented Oct 29, 2020

Updated "Share a Panel" topic.

Added section "Publish Snapshots" and a new image (image added to website repo: Add new image #2748).

From Ximena, for whom I created the PR:

The doc mentions Embed Panel and Direct Link but really should be a section for the Snapshot option which is the easiest of them all. ...

There's technically 3 ways to share a panel so having all 3 in that doc makes sense. IMHO "Publish Snapshots" should be at the top due to how 1-2-3 easy it is to do.

Copy link
Contributor

@oddlittlebird oddlittlebird left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice updates! If you are feeling ambitious, "Share a panel - Break up and improve" is on the short-term backlog.

This topic documents the Share Panel modal, accessed by clicking a panel title in a dashboard. There is a lot of room for improvement, with at least three obvious tasks to document and a lot of the content is either incomplete or out-of-date.

docs/sources/sharing/share-panel.md Outdated Show resolved Hide resolved
docs/sources/sharing/share-panel.md Outdated Show resolved Hide resolved
docs/sources/sharing/share-panel.md Outdated Show resolved Hide resolved
Copy link
Contributor

@oddlittlebird oddlittlebird left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved, but see comment about something that looks like it does not belong in this PR.

@@ -0,0 +1 @@
/frontend-docs/packages_api
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this supposed to be here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do not know and I do not think so. How do I remove it?

@oddlittlebird
Copy link
Contributor

@mckn , could you take a look at this? Got this issue in the build.

generating markdown from documentation data...

1140 | yarn run v1.22.5
1141 | $ api-documenter markdown --input-folder ./reports/docs/ --output-folder ./docs/sources/packages_api/ --hugo
1142 |  
1143 | api-documenter 0.9.3 - https://api-extractor.com/
1144 |  
1145 | Error: EEXIST: file already exists, mkdir '/drone/src/docs/sources/packages_api'
1146 | error Command failed with exit code 1.
1147 | info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
1148 | Failed to build packages and extract docs

achatterjee-grafana pushed a commit that referenced this pull request Oct 30, 2020
@achatterjee-grafana
Copy link
Contributor Author

Created PR 28708 with the same changes made here. Closing this one.

achatterjee-grafana added a commit that referenced this pull request Oct 30, 2020
aknuds1 pushed a commit that referenced this pull request Nov 3, 2020
aknuds1 pushed a commit that referenced this pull request Nov 5, 2020
ryantxu pushed a commit that referenced this pull request Nov 18, 2020
sourcegraph-bot pushed a commit to sgtest/megarepo that referenced this pull request Nov 24, 2021
Commit: 24a98213bb40798ddcca943450cbe1605b54fee2
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants