fix syntax error with tekton results data model diagram

[cmorinupgrade]

Changes

Mermaid does not support titles for graph. If we want to have a title we would need to proceed with:

graph BT
  title[Tekton Results Data Model]
  B(TaskRun) --> |Record| A[Result]
  C(Log) --> |Record| A
  D(PipelineRun) --> |Record| A

which would produce:

However, there is a header just above the diagram so the title is redundant.

I propose that we remove the title completely.

/kind docs

Release Notes

docs: Fix mermaid.js diagram for the Results data model

[tekton-robot]

@cmorinupgrade: The label(s) kind/docs cannot be applied, because the repository doesn't have them.

In response to this:

/kind docs

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[tekton-robot]

Hi @cmorinupgrade. Thanks for your PR.

I'm waiting for a tektoncd member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[AlanGreene]

Hey @cmorinupgrade, is this related to an issue on the docs site? If so it might just be a matter of updating the mermaid version used on the website as the current syntax is working on GitHub:
https://github.com/tektoncd/results?tab=readme-ov-file#data-model

[AlanGreene]

Title support was added in mermaid 9.3.0

feat: Title support via front matter for ER, state, class, git, and graph diagrams (mermaid-js/mermaid#3706) @MasonM

[cmorinupgrade]

Title support was added in mermaid 9.3.0

feat: Title support via front matter for ER, state, class, git, and graph diagrams (mermaid-js/mermaid#3706) @MasonM

Good catch. Granted we could update the version! Repeating the title would still be duplication though. I would personally do both update the version and remove the repeated title. I removed it to match the same pattern we can see under Life of a Result section (we do not add the title again in the diagram).

I will leave it up to the reviewers to decide.

Thanks Alan

[AlanGreene]

Sounds good. I've also opened a PR to see if the updated version works on the website 🤞 tektoncd/website#588

Edit: that seems to have done the trick

[AlanGreene]

/ok-to-test

[adambkaplan]

/approve

Per @AlanGreene - this will work with the docs site as well.

I've added a release note, 🤞 the bot is happy, in which case I'll add lgtm too.

[tekton-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: adambkaplan

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [adambkaplan]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[adambkaplan]

/lgtm

[avinal]

Ah I was unable to respond in time: This issue is known and I had opened issue about it, closed due to inactivity: tektoncd/website#544. As per last discussion, we are using a certain hugo theme in our tektoncd website. Last time I checked the theme hasn't updated the mermaid version. It seems to be updated now.