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

Migrate multipass docs pages #1440

Merged
merged 3 commits into from
Nov 29, 2024

Conversation

britneywwc
Copy link
Contributor

@britneywwc britneywwc commented Nov 27, 2024

Need to add new doc site to Google Custom Search Engine (https://github.com/canonical/canonicalwebteam.search?tab=readme-ov-file#new-sites)

Done

  • Migrate multipass.run/docs to c.com/multipass/docs
  • Including Multipass docs and search

QA

Issue / Card

Fixes WD-16619

Screenshots

[if relevant, include a screenshot]

@webteam-app
Copy link

@britneywwc britneywwc changed the title Multipass docs Migrate multipass docs pages Nov 27, 2024
Comment on lines 4 to 5
search_action="https://canonical.com/multipass/docs/search",
siteSearch="https://canonical.com/multipass/docs",
Copy link
Contributor

Choose a reason for hiding this comment

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

search_action="/multipass/docs/search",
siteSearch="/multipass/docs",

Copy link
Contributor

Choose a reason for hiding this comment

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

Because /multipass/docs isn't there on canonical.com yet, so it's gonna return 404

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm trying to QA it locally and running the search on https://0.0.0.0:8002/microstack/docs/search?q=testing&siteSearch=%2Fmicrostack%2Fdocs

Is there no other way to QA search besides on prod?

Copy link
Contributor

@muhammad-ali-pk muhammad-ali-pk Nov 29, 2024

Choose a reason for hiding this comment

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

You can test it locally, given you have an API key in your env (SEARCH_API_KEY) for the search module.
PS., you gotta remove the domain from urls in BOTH the document.html and search-results.html file (you missed the search_action and siteSearch in document.html) for it to work.

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 good catch thanks, I updated document.html! I do have the SEARCH_API_KEY in my local environment, the search just doesn't return any results

templates/multipass/docs/search-results.html Outdated Show resolved Hide resolved
templates/multipass/docs/search-results.html Outdated Show resolved Hide resolved
@britneywwc britneywwc marked this pull request as ready for review November 29, 2024 07:51
Co-authored-by: Muhammad Ali <[email protected]>
Copy link
Contributor

@muhammad-ali-pk muhammad-ali-pk left a comment

Choose a reason for hiding this comment

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

LGTM!

@britneywwc britneywwc merged commit 05b0146 into canonical:feature-multipass Nov 29, 2024
8 checks passed
@britneywwc britneywwc deleted the multipass-docs branch November 29, 2024 10:35
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.

3 participants