Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Blog: fix typos in APISIX blog #1254

Merged
merged 2 commits into from
Mar 31, 2022
Merged

Blog: fix typos in APISIX blog #1254

merged 2 commits into from
Mar 31, 2022

Conversation

yzeng25
Copy link
Contributor

@yzeng25 yzeng25 commented Mar 31, 2022

Found some typos as I was going through the blog again.

  1. Change "OpenTelemetry" to "OpenTelemetry" in the topic.
  2. Change "affectting" to "affecting".
  3. Change "OpenTelemetery" to "OpenTelemetry".
  4. Change "docekr-compose.yaml" to "docker-compose.yaml"

@yzeng25 yzeng25 marked this pull request as ready for review March 31, 2022 03:26
@yzeng25 yzeng25 marked this pull request as draft March 31, 2022 09:38
@yzeng25 yzeng25 marked this pull request as ready for review March 31, 2022 09:59
@yzeng25
Copy link
Contributor Author

yzeng25 commented Mar 31, 2022

Hi @chalin @SergeyKanzhelev , sorry to bother you guys again, could you take a look on this pull request when available, thanks a lot!

Copy link
Contributor

@chalin chalin left a comment

Choose a reason for hiding this comment

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

Great! Thanks for catching those through another careful review of your post. ✨

linkTitle: Apache APISIX-Opentelemetry Integration
date: 2022-03-26
author: Haochao Zhuang, Fei Han
canonical_url: https://apisix.apache.org/blog/2022/02/28/apisix-integration-opentelemetry-plugin/
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm unsure what our policy will be about canonical URLs for regular blog posts (btw, this doesn't set the page's canonical URL yet). I'll bring this up during our next Comms/website meeting.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's kind of a long story... This blog is originally written and edited by Fei and Haochao.

Then it is published on Apache APISIX Blog https://apisix.apache.org/blog/2022/02/28/apisix-integration-opentelemetry-plugin

Then I created a pull request for it in OpenTelemetry's repo. #1185

After modifications, it finally gets published on their website. https://opentelemetry.io/blog/2022/apisix/

Finally, I had some voices from the community said that canonical URL should be added, otherwise one of the pages will be downgraded by search engine, which is bad for SEO.

After some discussions in apache/apisix-website#995, we figure the best way to work this out is to add a canonical URL here.

So I read through previous blogs and find canonical_url as the solution for it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Is it required to add [original post]: {{% param canonical_url %}} as well to complete the canonical URL?

Copy link
Contributor

Choose a reason for hiding this comment

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

You can certainly add that to the end of your post, similarly to what was done for https://opentelemetry.io/blog/2022/troubleshooting-nodejs/ (see the end of the page). That is:

A version of this article was originally posted on the Apache APISIX blog.

Using {{% param canonical_url %}} for the link definition. See https://github.com/open-telemetry/opentelemetry.io/blob/main/content/en/blog/2022/troubleshooting-nodejs.md for an example.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah I get it now, thanks @chalin!

@chalin chalin merged commit 95e0886 into open-telemetry:main Mar 31, 2022
@yzeng25 yzeng25 deleted the apisix_typo branch March 31, 2022 14:11
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants