Skip to content

update logic for x-metatags to use the standard term used by webteam … #4972

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

Merged
merged 4 commits into from
Jul 22, 2025

Conversation

georgewallace
Copy link
Contributor

Updating the new x-metatags logic implemented to update the name. The web team and docs are already leveraging product_name for facets. The current implementation converts the key value pair in the x-metatags area to a head element in the HTML. By changing to product_name this will work as expected with currently workflows with docs and the web team for site search.

@georgewallace georgewallace requested a review from a team as a code owner July 18, 2025 16:54
@georgewallace
Copy link
Contributor Author

georgewallace commented Jul 18, 2025

@l-trotta, @szabosteve , and @lcawl making a minor update to what we just created for the product facets. This will align with what we currently have for docs and the webteam for search. This is related to #4511

Copy link
Contributor

Following you can find the validation changes against the target branch for the APIs.

No changes detected.

You can validate these APIs yourself by using the make validate target.

lcawl and others added 2 commits July 18, 2025 10:32
updating the friendly names as bump logic does not convert product ID to product Name
@l-trotta
Copy link
Contributor

isn't this outdated? #4511 had an update, #4860 where the output format is changed

@georgewallace
Copy link
Contributor Author

the output format did change. What I am looking for us to change is the table to use actual product names vs the ids as bump has no way to change the logic. And since we went with x-metatags there is no need to have the value in the key value pair be x-product-feature. We can just call it product_name. That is what is going to be passed to the final output on the webpage. cc: @szabosteve Please correct me if I am wrong here.

@georgewallace
Copy link
Contributor Author

I did double check and the update I made is able to be processed by bump and shows as we expect it to show.
Screenshot 2025-07-22 at 9 13 29 AM

Copy link
Contributor

@l-trotta l-trotta left a comment

Choose a reason for hiding this comment

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

if @szabosteve approves then it's fine by me!

Copy link
Contributor

@szabosteve szabosteve left a comment

Choose a reason for hiding this comment

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

Thanks for the multiple pings, I just got back and missed some.
As far as I see, this PR changes the product names and changes x-product-feature to product-name. The format Laura provided for bump is still the same (Map).

@georgewallace georgewallace merged commit 51504a2 into main Jul 22, 2025
8 checks passed
@georgewallace georgewallace deleted the georgewallace-patch-1 branch July 22, 2025 16:36
Copy link
Contributor

The backport to 8.19 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-8.19 8.19
# Navigate to the new working tree
cd .worktrees/backport-8.19
# Create a new branch
git switch --create backport-4972-to-8.19
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 51504a22d49d51140d6ba568adca866a4cc44388
# Push it to GitHub
git push --set-upstream origin backport-4972-to-8.19
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-8.19

Then, create a pull request where the base branch is 8.19 and the compare/head branch is backport-4972-to-8.19.

Copy link
Contributor

The backport to 9.0 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-9.0 9.0
# Navigate to the new working tree
cd .worktrees/backport-9.0
# Create a new branch
git switch --create backport-4972-to-9.0
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 51504a22d49d51140d6ba568adca866a4cc44388
# Push it to GitHub
git push --set-upstream origin backport-4972-to-9.0
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-9.0

Then, create a pull request where the base branch is 9.0 and the compare/head branch is backport-4972-to-9.0.

georgewallace added a commit that referenced this pull request Jul 22, 2025
#4972)

* update logic for x-metatags to use the standard term used by webteam for other docs

* Generate output

* Update product-meta.json

updating the friendly names as bump logic does not convert product ID to product Name

* Updating main product in product_str to be friendly name

---------

Co-authored-by: lcawl <lcawley@elastic.co>
(cherry picked from commit 51504a2)
@georgewallace
Copy link
Contributor Author

💚 All backports created successfully

Status Branch Result
8.19

Questions ?

Please refer to the Backport tool documentation

georgewallace added a commit that referenced this pull request Jul 22, 2025
#4972)

* update logic for x-metatags to use the standard term used by webteam for other docs

* Generate output

* Update product-meta.json

updating the friendly names as bump logic does not convert product ID to product Name

* Updating main product in product_str to be friendly name

---------

Co-authored-by: lcawl <lcawley@elastic.co>
(cherry picked from commit 51504a2)
@georgewallace
Copy link
Contributor Author

💚 All backports created successfully

Status Branch Result
9.0

Questions ?

Please refer to the Backport tool documentation

georgewallace added a commit that referenced this pull request Jul 22, 2025
#4972)

* update logic for x-metatags to use the standard term used by webteam for other docs

* Generate output

* Update product-meta.json

updating the friendly names as bump logic does not convert product ID to product Name

* Updating main product in product_str to be friendly name

---------

Co-authored-by: lcawl <lcawley@elastic.co>
(cherry picked from commit 51504a2)
@georgewallace
Copy link
Contributor Author

💚 All backports created successfully

Status Branch Result
9.1

Questions ?

Please refer to the Backport tool documentation

lcawl added a commit that referenced this pull request Jul 22, 2025
#4972)

* update logic for x-metatags to use the standard term used by webteam for other docs

* Generate output

* Update product-meta.json

updating the friendly names as bump logic does not convert product ID to product Name

* Updating main product in product_str to be friendly name

---------

Co-authored-by: lcawl <lcawley@elastic.co>
lcawl pushed a commit that referenced this pull request Jul 22, 2025
lcawl added a commit that referenced this pull request Jul 22, 2025
#4972) (#5027)

(cherry picked from commit 51504a2)

Co-authored-by: lcawl <lcawley@elastic.co>
lcawl added a commit that referenced this pull request Jul 22, 2025
#4972) (#5025)

(cherry picked from commit 51504a2)

Co-authored-by: lcawl <lcawley@elastic.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants