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: add mermaid diagrams #3705

Merged
merged 1 commit into from
Aug 29, 2023
Merged

docs: add mermaid diagrams #3705

merged 1 commit into from
Aug 29, 2023

Conversation

cdrage
Copy link
Contributor

@cdrage cdrage commented Aug 29, 2023

docs: add mermaid diagrams

What does this PR do?

Adds mermaid diagrams to be used within the website.

Screenshot/screencast of this PR

Screen.Recording.2023-08-29.at.10.01.49.AM.mov

What issues does this PR fix or reference?

Closes #3706

N/A

How to test this PR?

Add:

```mermaid
graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;

To an example markdown page.

<!-- Please explain steps to reproduce -->

Signed-off-by: Charlie Drage <[email protected]>

@cdrage cdrage requested review from slemeur, themr0c, benoitf and a team as code owners August 29, 2023 14:03
@cdrage cdrage requested review from dgolovin and lstocchi and removed request for a team August 29, 2023 14:03
@cdrage
Copy link
Contributor Author

cdrage commented Aug 29, 2023

As requested by @themr0c

Copy link
Collaborator

@benoitf benoitf left a comment

Choose a reason for hiding this comment

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

I think yarn.lock changes is missing

@cdrage
Copy link
Contributor Author

cdrage commented Aug 29, 2023

I think yarn.lock changes is missing

You're right. It was ignored by mistake! Added.

Copy link
Collaborator

@benoitf benoitf left a comment

Choose a reason for hiding this comment

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

I think there is something wrong in the yarn.lock changes (like trim being updated, etc)

could you revert yarn.lock changes and then run yarn command in the root folder and not in the website folder

I think then we should have a better yarn.lock file (most added lines and no replacement lines)

Copy link
Collaborator

@benoitf benoitf left a comment

Choose a reason for hiding this comment

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

request for changes is only for yarn.lock, other changes are 👍

### What does this PR do?

Adds mermaid diagrams to be used within the website.

### Screenshot/screencast of this PR

https://github.com/containers/podman-desktop/assets/6422176/d893c7c8-ae28-4e47-90f6-84547b44b944

<!-- Please include a screenshot or a screencast
explaining what is doing this PR -->

### What issues does this PR fix or reference?

Closes containers#3706

<!-- Include any related issues from Podman Desktop
repository (or from another issue tracker). -->

N/A

### How to test this PR?

Add:

```
```mermaid
graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;
```
```

To an example markdown page.

Signed-off-by: Charlie Drage <[email protected]>
@cdrage
Copy link
Contributor Author

cdrage commented Aug 29, 2023

Updated! Reran yarn in the main root. It does look like it got messed up.

I did:

  1. Added "@docusaurus/theme-mermaid": "^2.4.1", to package.json
  2. Ran yarn in the main folder.

Trim is no longer being updated now. Good catch!

@cdrage cdrage enabled auto-merge (squash) August 29, 2023 15:11
@cdrage cdrage merged commit 557a399 into containers:main Aug 29, 2023
11 checks passed
@podman-desktop-bot podman-desktop-bot added this to the 1.4.0 milestone Aug 29, 2023
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.

Website: We should have diagrams
4 participants