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

docs(chart):add KB to link to export example #2124

Merged
merged 5 commits into from
Jun 3, 2024
Merged

Conversation

NansiYancheva
Copy link
Contributor

@NansiYancheva NansiYancheva requested a review from a team as a code owner May 20, 2024 15:52
Copy link
Contributor

@yordan-mitev yordan-mitev left a comment

Choose a reason for hiding this comment

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

The value of this KB is questionable at best as it lacks content. I would suggest reworking it and adding at least the primary steps required to export the Chart as an image. You could of course keep the link to the GitHub project with the complete implementation.

@NansiYancheva
Copy link
Contributor Author

The value of this KB is questionable at best as it lacks content. I would suggest reworking it and adding at least the primary steps required to export the Chart as an image. You could of course keep the link to the GitHub project with the complete implementation.

@yordan-mitev

The reasons for the KB appearing as it does are:

  1. The main reason for creating the KB is the lack of a link to the GitHub project in the documentation.
  2. The GitHub project has instructions. We aim to avoid duplication of the guidelines (and their maintenance). The KB indicates that the GitHub project contains a README file with instructions.
  3. We have another KB that looks the same https://docs.telerik.com/blazor-ui/knowledge-base/chart-print-chart-only
  4. Additionally, we are planning to deprecate the GitHub repository and extract what is possible into KBs. In the meantime, we are trying to avoid duplicating guidelines while still utilizing available resources.

If these reasons are not acceptable, I will include the instructions from the GitHub project in the KB.

@ntacheva
Copy link
Contributor

We have this type of KB articles for most projects in the blazor-ui repo. Their main purpose is to provide a link to the corresponding project.

Indeed, we have previously discussed that such KBs do not have much value. In addition, a lot of the customers do not like the idea of having to browse to the repo and download the app in order to just test the specific scenario. That said, we will have an initiative for extracting all projects to KBs and deprecate the blazor-ui repo. This, however will take time and we better have the KB linking the app until then.

@ntacheva ntacheva added the merge-to-production Use this label to get a comment to choose whether to merge the PR to production label May 28, 2024
Copy link
Contributor

Hello @ntacheva,

Check the below option if you would like to automatically generate PR to production. The automation uses the branch for the cherry-pick, and then will delete the branch. Please, do not delete it manually.

  • create PR to production

@NansiYancheva
Copy link
Contributor Author

@yordan-mitev please let us know if you are ok with the proposed approach

knowledge-base/chart-export-to-image.md Outdated Show resolved Hide resolved
knowledge-base/chart-export-to-image.md Outdated Show resolved Hide resolved
knowledge-base/chart-export-to-image.md Outdated Show resolved Hide resolved
@yordan-mitev
Copy link
Contributor

@yordan-mitev please let us know if you are ok with the proposed approach

You are free to add the file as is. This, however, is not an actual KB and has no value.

  • The main idea of a KB is to allow our clients to find solutions on their own. They cannot find a solution if it isn't described in an article that has sufficient content to allow search engines to index it.
  • A KB that isn't indexed or ranked high serves no purpose if you are the one who has to send the link to the client.

@NansiYancheva NansiYancheva merged commit 4537533 into master Jun 3, 2024
1 check passed
Copy link
Contributor

github-actions bot commented Jun 3, 2024

Here you are the link to your PR to production: 2138

@github-actions github-actions bot deleted the kb-chart-export branch June 3, 2024 15:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
merge-to-production Use this label to get a comment to choose whether to merge the PR to production
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants