Skip to content

Fix mermaid flowchart syntax in Indexables technical specification #368

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix mermaid flowchart syntax in Indexables technical specification #368

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 19 additions & 19 deletions docs/features/indexables/technical-specification.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,26 +24,26 @@ considered indexable objects. Of course a post has to _exist_ to be a valid Inde

```mermaid
%%{init: {'theme': 'base', 'themeVariables': { 'edgeLabelBackground':'#ffffff', 'stroke':'#000'}}}%%
flowchart TD
flowchart TD
Input([Post]) --> PTRegistered{Post <em>type</em> registered?}
PTRegistered == Yes ==>PTExcluded{Post <em>type</em> excluded<br/><a href='/features/indexables/indexables-filters/#post_types'>through filter</a>?}
PTRegistered -- No -->NoIndexable([Do <strong>not</strong> create an indexable])
PTExcluded -- Yes -->PTIncluded{Post <em>type</em> force included<br/><a href='/features/indexables/indexables-filters/#included_post_types'>through filter</a>?}
PTExcluded == No ==>PTPublic{Is the<br/>post <em>type</em> <code>public</code>?}
PTPublic == Yes ==>PTAttachment{Is the post<br/><em>type</em> <code>attachment</code>?}
PTPublic == No ==>PTIncluded
PTAttachment -- Yes -->AttDisabled{Are <a href='https://yoast.com/features/redirect-attachment-urls/'>attachment URLs<br/> disabled</a> in Yoast SEO?}
AttDisabled -- Yes -->PTIncluded
AttDisabled == No ==>PSRegistered{Post <em>status</em> registered?}
PTAttachment == No ==>PSRegistered
PSRegistered -- No -->NoIndexable
PSRegistered == Yes ==>PSPublic{Is the post<br/><em>status</em> <code>public</code>?}
PSPublic -- No -->IncludedNonPublishPostStatus{Post <em>status</em> one of:<br/><code>draft</code>, <code>pending</code>, <code>future</code>?}
PTIncluded == No -->NoIndexable
PTIncluded == Yes -->CreateIndexable
IncludedNonPublishPostStatus -- No -->NoIndexable
IncludedNonPublishPostStatus == Yes ==>CreateIndexable
PSPublic == Yes ==>CreateIndexable([Create an indexable])
PTRegistered -- Yes --> PTExcluded{Post <em>type</em> excluded<br/><a href='/features/indexables/indexables-filters/#post_types'>through filter</a>?}
PTRegistered -- No --> NoIndexable([Do <strong>not</strong> create an indexable])
PTExcluded -- Yes --> PTIncluded{Post <em>type</em> force included<br/><a href='/features/indexables/indexables-filters/#included_post_types'>through filter</a>?}
PTExcluded -- No --> PTPublic{Is the<br/>post <em>type</em> <code>public</code>?}
PTPublic -- Yes --> PTAttachment{Is the post<br/><em>type</em> <code>attachment</code>?}
PTPublic -- No --> PTIncluded
PTAttachment -- Yes --> AttDisabled{Are <a href='https://yoast.com/features/redirect-attachment-urls/'>attachment URLs<br/> disabled</a> in Yoast SEO?}
AttDisabled -- Yes --> PTIncluded
AttDisabled -- No --> PSRegistered{Post <em>status</em> registered?}
PTAttachment -- No --> PSRegistered
PSRegistered -- No --> NoIndexable
PSRegistered -- Yes --> PSPublic{Is the post<br/><em>status</em> <code>public</code>?}
PSPublic -- No --> IncludedNonPublishPostStatus{Post <em>status</em> one of:<br/><code>draft</code>, <code>pending</code>, <code>future</code>?}
PTIncluded -- No --> NoIndexable
PTIncluded -- Yes --> CreateIndexable([Create an indexable])
IncludedNonPublishPostStatus -- No --> NoIndexable
IncludedNonPublishPostStatus -- Yes --> CreateIndexable
PSPublic -- Yes --> CreateIndexable
style Input fill:#ddf,stroke:#aaf,stroke-width:2px
style NoIndexable fill:#ffcccc,stroke:#f00,stroke-width:2px
style CreateIndexable fill:#ccffcc,stroke:#0f0,stroke-width:2px
Expand Down