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

Dead link in Google results for API docs #2600

Closed
wooorm opened this issue Nov 5, 2019 · 6 comments
Closed

Dead link in Google results for API docs #2600

wooorm opened this issue Nov 5, 2019 · 6 comments

Comments

@wooorm
Copy link

wooorm commented Nov 5, 2019

Describe the bug

I was hoping to see if there was a nice API to search OC, and...

To Reproduce

  1. Google “OpenCollective API”
  2. Click on the first result (https://docs.opencollective.com/help/developers/api)
  3. Get a 404 not found

Expected behavior

A redirect to a new place

Additional context

For the XY problem: If anyone has tips on how to search for the most active companies that sponsor through OC, I was hacking on sort of the inverse of back your stack: a dashboard for maintainers to see who is recently interacting with their orgs, where they work, etc.

@znarf
Copy link
Member

znarf commented Nov 5, 2019

The documentation team is currently working on a refactor. They should have an idea. cc @alanna @contraexemplo

For the API, I would recommend exploring our GraphQL API from here:
https://medium.com/open-collective/open-collective-graphql-api-preview-3b42ed1d55ff The post is 1 year old but everything there should still be valid. Ping me on slack if you need anything specific.

About "Reverse BackYourStack", someone close to us is working on something in that spirit, see: https://github.com/RichardLitt/jabbar

@wooorm
Copy link
Author

wooorm commented Nov 5, 2019

Sweet, thanks! Yeah I was talking to Richard about it as well, it aligns a bit with jabbar!

@contraexemplo
Copy link

contraexemplo commented Nov 5, 2019

That URL has in fact changed! It should take some time until Google updates that, I believe? I added that to the redirect list over here https://github.com/opencollective/documentation/blob/v2/.gitbook.yaml but it doesn't seem to be working as it should. I'll investigate that!

@contraexemplo
Copy link

So it looks like my redirects aren't working but I can't figure out why. Here's the docs talking about that on GitBook: https://docs.gitbook.com/integrations/github/content-configuration GitBook uses a versioning system that is not Git to manage content, so it doesn't really keep track that well on folders that were renamed, files moved, etc.

@contraexemplo
Copy link

@znarf and I were able to solve this after chatting over Slack: opencollective/documentation@d187972 I had to drop the help prefix and add a ./to every single redirect. It seems to be working just fine now! Can you confirm that, @wooorm?

@wooorm
Copy link
Author

wooorm commented Nov 6, 2019

This works great, thanks @contraexemplo and @znarf!

@wooorm wooorm closed this as completed Nov 6, 2019
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

No branches or pull requests

3 participants