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

Set up search console verification #2616

Closed
stichbury opened this issue May 30, 2023 · 6 comments
Closed

Set up search console verification #2616

stichbury opened this issue May 30, 2023 · 6 comments
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation

Comments

@stichbury
Copy link
Contributor

stichbury commented May 30, 2023

I'm trying to add a verification file to the docs so that I can use search console on the docs to see what query strings are bringing users to our pages.

Have been following this https://stackoverflow.com/questions/27748396/using-google-analytics-in-readthedocs-org

  • I generated a verification file
  • Added it to docs/source and updated conf.py
  • Rebuilt docs, but the file isn't in the root of the html folder

I think this is because source is in the exclusion list in conf.py and wondered if you have any thoughts @astrojuanlu on whether I can put the verification elsewhere and then move it into the root, or get around the exclusion list somehow?

Here's my branch

PS: I'm mindful that RTD does give us comprehensive search analytics so this is a nice-to-have rather than essential, but it'll sit well side by side with the analytics we're getting for kedro.org and the blog.

@stichbury stichbury added the Component: Documentation 📄 Issue/PR for markdown and API documentation label May 30, 2023
@astrojuanlu
Copy link
Member

Yeah, having source in exclude_patterns always looked wrong to me. I'll have a look at this during the week.

@astrojuanlu
Copy link
Member

File is live at https://docs.kedro.org/en/stable/googlebce3ad2fda582ae8.html as per gh-2631, hopefully this can be closed?

@stichbury
Copy link
Contributor Author

@astrojuanlu it's not working :(

So the file needs to be at docs.kedro.org/google..... and because of the way the RTD folder structure is set up, obviously isn't (it's in the en/stable subdirectory). I set up a redirect in RTD but that doesn't seem to be working (https://docs.kedro.org/googlebce3ad2fda582ae8.html is returning page not found).

Please can you advise? Is there a way I can fake the location?

@astrojuanlu
Copy link
Member

Merghhhh too bad. I see there are other verification methods available:

https://support.google.com/webmasters/answer/9008080?hl=en#choose_method

Maybe we can try HTML Meta tags or using the existing GA tracking code?

@stichbury
Copy link
Contributor Author

I guess I should revert the commit that added the file for completeness. Will do that now and close this.

@astrojuanlu
Copy link
Member

xref gh-2674

Do you still intend to explore the other methods? (Otherwise let's indeed keep the issue closed)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation
Projects
Archived in project
Development

No branches or pull requests

2 participants