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

Add description for /acs/systems #375

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Add description for /acs/systems #375

wants to merge 7 commits into from

Conversation

razor-x
Copy link
Contributor

@razor-x razor-x commented Oct 10, 2024

For SEO we should have a page title. This adds the description but maybe we need title too? It's defaulting to just Systems. This would be used later when we autogen the SUMMARY.md file.

image

@razor-x razor-x marked this pull request as ready for review October 10, 2024 23:39
@razor-x razor-x requested review from a team as code owners October 10, 2024 23:39
@DebbieAtSeam
Copy link
Contributor

I'd be interested to learn how it's deciding to use "Systems" with a caps "S" as the page title. There should certainly be a page title, and I think there might be circumstances under which we might want to set the page title to be different from the route/endpoint/etc. name. Is this the situation that we're talking about here? For example, devices/get should have the title "Get a Device" and ACS/users/create --> "Create an ACS User"

Comment on lines +3 to +20
page:
title: Systems
description: Access Control Systems

/acs/systems/get:
page:
title: Get an ACS System
description: Get an ACS System

/acs/systems/list:
page:
title: List ACS Systems
description: List ACS Systems

/acs/systems/list_compatible_credential_manager_acs_systems:
page:
title: List Compatible Credential Manager ACS Systems
description: List Compatible Credential Manager ACS Systems
Copy link
Contributor Author

@razor-x razor-x Oct 15, 2024

Choose a reason for hiding this comment

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

@DebbieAtSeam Can you suggest descriptions here? The page titles need to match what is in SUMMARY.md and will be used later to generate that section of SUMMARY.md.

The page descriptions are for SEO. We can't use the long form descriptions because they may be too long or contain markdown formatting.

I am somewhat concerned about duplicated content.

image

Comment on lines +4 to +6
```
/acs/systems
```
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@DebbieAtSeam Thoughts on putting the route on the page somewhere? I don't like this format, but how else to show it?
image

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.

4 participants