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 Open Liberty APIs/SPIs to the SEO on docs #3323

Merged
merged 4 commits into from
Aug 15, 2023

Conversation

steven1046
Copy link
Member

What was changed and why?

Added Open Liberty APIs/SPIs to the SEO for docs.
Fixes #3293

Tested using browser:

  • Firefox (Desktop)
  • Safari (Desktop)
  • Chrome (Desktop)

@steven1046 steven1046 requested a review from chirp1 August 14, 2023 17:37
@steven1046
Copy link
Member Author

steven1046 commented Aug 14, 2023

@chirp1, can you please review the wording change for SEO to include Open Liberty APIs/SPIs? Since Open Liberty are the only SPIs on the website, i added API to each of the other kind of javadocs in the sentence to show only Open Liberty have APIs and SPIs. Maybe we could make it a new sentence if it's too long.

Old sentence:
Open Liberty documentation and reference materials for developers to build applications and for administrators and operation teams to manage DevOps and deploy workloads to clouds using open cloud-native Java. Covers Open Liberty basics, development, security, deployment, and operations topics, as well as Javadoc for Jakarta EE, MicroProfile and Java EE APIs.

New sentence:
Open Liberty documentation and reference materials for developers to build applications and for administrators and operation teams to manage DevOps and deploy workloads to clouds using open cloud-native Java. Covers Open Liberty basics, development, security, deployment, and operations topics, as well as Javadoc for Jakarta EE APIs, MicroProfile APIs, Java EE APIs, and Open Liberty APIs/SPIs.

@steven1046 steven1046 changed the base branch from prod to draft August 14, 2023 17:38
@chirp1 chirp1 requested review from dmuelle and ramkumar-k-9286 and removed request for chirp1 August 15, 2023 12:52
@chirp1
Copy link
Contributor

chirp1 commented Aug 15, 2023

@dmuelle @ramkumar-k-9286 Hi! Since you are working on the API/SPI landing pages, would you review for Steven? Thanks!

@dmuelle
Copy link
Member

dmuelle commented Aug 15, 2023

Hi Steven- where does this text show up?

Copy link
Member

@dmuelle dmuelle left a comment

Choose a reason for hiding this comment

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

ID review- minor edits for clarity and sentence length

@@ -8,7 +8,7 @@
{{else if page.attributes.description }}
<meta name="description" content="{{page.attributes.description}}">
{{ else }}
<meta name="description" content="Open Liberty documentation and reference materials for developers to build applications and for administrators and operation teams to manage DevOps and deploy workloads to clouds using open cloud-native Java. Covers Open Liberty basics, development, security, deployment, and operations topics, as well as Javadoc for Jakarta EE, MicroProfile and Java EE APIs.">
<meta name="description" content="Open Liberty documentation and reference materials for developers to build applications and for administrators and operation teams to manage DevOps and deploy workloads to clouds using open cloud-native Java. Covers Open Liberty basics, development, security, deployment, and operations topics, as well as Javadoc for Jakarta EE APIs, MicroProfile APIs, Java EE APIs, and Open Liberty APIs/SPIs.">
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
<meta name="description" content="Open Liberty documentation and reference materials for developers to build applications and for administrators and operation teams to manage DevOps and deploy workloads to clouds using open cloud-native Java. Covers Open Liberty basics, development, security, deployment, and operations topics, as well as Javadoc for Jakarta EE APIs, MicroProfile APIs, Java EE APIs, and Open Liberty APIs/SPIs.">
<meta name="description" content="Open Liberty documentation and reference materials for developers to build applications and for administrators and operation teams to manage DevOps and deploy workloads to clouds by using open cloud-native Java. This content covers Open Liberty basics, development, security, deployment, and operations topics. It also includes Javadoc for Jakarta EE APIs, MicroProfile APIs, Java EE APIs, and Open Liberty APIs and SPIs.">

@@ -23,7 +23,7 @@
{{else if page.attributes.description }}
<meta name="twitter:description" content="{{ page.attributes.description }}" />
{{ else }}
<meta name="twitter:description" content="Open Liberty documentation and reference materials for developers to build applications and for administrators and operation teams to manage DevOps and deploy workloads to clouds using open cloud-native Java. Covers Open Liberty basics, development, security, deployment, and operations topics, as well as Javadoc for Jakarta EE, MicroProfile and Java EE APIs." />
<meta name="twitter:description" content="Open Liberty documentation and reference materials for developers to build applications and for administrators and operation teams to manage DevOps and deploy workloads to clouds using open cloud-native Java. Covers Open Liberty basics, development, security, deployment, and operations topics, as well as Javadoc for Jakarta EE APIs, MicroProfile APIs, Java EE APIs, and Open Liberty APIs/SPIs." />
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
<meta name="twitter:description" content="Open Liberty documentation and reference materials for developers to build applications and for administrators and operation teams to manage DevOps and deploy workloads to clouds using open cloud-native Java. Covers Open Liberty basics, development, security, deployment, and operations topics, as well as Javadoc for Jakarta EE APIs, MicroProfile APIs, Java EE APIs, and Open Liberty APIs/SPIs." />
<meta name="description" content="Open Liberty documentation and reference materials for developers to build applications and for administrators and operation teams to manage DevOps and deploy workloads to clouds by using open cloud-native Java. This content covers Open Liberty basics, development, security, deployment, and operations topics. It also includes Javadoc for Jakarta EE APIs, MicroProfile APIs, Java EE APIs, and Open Liberty APIs and SPIs.">

@@ -39,7 +39,7 @@
{{else if page.attributes.description }}
<meta property="og:description" content="{{ page.attributes.description }}" />
{{ else }}
<meta property="og:description" content="Open Liberty documentation and reference materials for developers to build applications and for administrators and operation teams to manage DevOps and deploy workloads to clouds using open cloud-native Java. Covers Open Liberty basics, development, security, deployment, and operations topics, as well as Javadoc for Jakarta EE, MicroProfile and Java EE APIs." />
<meta property="og:description" content="Open Liberty documentation and reference materials for developers to build applications and for administrators and operation teams to manage DevOps and deploy workloads to clouds using open cloud-native Java. Covers Open Liberty basics, development, security, deployment, and operations topics, as well as Javadoc for Jakarta EE APIs, MicroProfile APIs, Java EE APIs, and Open Liberty APIs/SPIs." />
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
<meta property="og:description" content="Open Liberty documentation and reference materials for developers to build applications and for administrators and operation teams to manage DevOps and deploy workloads to clouds using open cloud-native Java. Covers Open Liberty basics, development, security, deployment, and operations topics, as well as Javadoc for Jakarta EE APIs, MicroProfile APIs, Java EE APIs, and Open Liberty APIs/SPIs." />
<meta property="og:description" content="Open Liberty documentation and reference materials for developers to build applications and for administrators and operation teams to manage DevOps and deploy workloads to clouds by using open cloud-native Java. This content covers Open Liberty basics, development, security, deployment, and operations topics. It also includes Javadoc for Jakarta EE APIs, MicroProfile APIs, Java EE APIs, and Open Liberty APIs and SPIs.">

@steven1046
Copy link
Member Author

Hi Steven- where does this text show up?

When people see links to our docs on Google and Twitter.

Copy link
Member

@dmuelle dmuelle left a comment

Choose a reason for hiding this comment

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

LGTM, thanks

@steven1046 steven1046 merged commit 29c8eae into draft Aug 15, 2023
1 check passed
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.

api/spi: add content description
5 participants