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

Add related resources component to Docs Site #1353

Closed
3 of 4 tasks
jpvajda opened this issue Mar 16, 2021 · 2 comments · Fixed by #1717
Closed
3 of 4 tasks

Add related resources component to Docs Site #1353

jpvajda opened this issue Mar 16, 2021 · 2 comments · Fixed by #1717
Assignees
Labels
enhancement New feature or request

Comments

@jpvajda
Copy link

jpvajda commented Mar 16, 2021

As a follow up on #427 we want to now enable the right rail component to return related resource content links. In order to this we need to clarify some questions around cost and how we'll need to implement the refresh rate of content per page.

Considerations

  • We refetch results per page once a day on a cron job. The data is available as part of the build:
  • That data gets rebuilt in this action once a day:
  • We can specify whatever interval we want if we go this route. When we execute a query per page each time we fetch related content for a page. We have a limit on the number of queries we can run before we are charged more. We could decrease the interval and instead do once a week, or once a month. Doing so would put costs down, but means that auto related content could become stale (maybe thats a fair tradeoff)

Acceptance Criteria

  • confirm who will be paying for the additional costs to run the swiftype queries. - APPROVED it's all in Slack. in #swiftype-devs 👍

Cost

estimated cost: about 60k searches/month (assuming 2k searches * 30 days), just to populate the 
links for Related Content between $400 - $600 a month in swiftype 
cost. This is based on our current pricing plan

Interval

To cap it at 60k queries a month, that means we can do 2K a day max...since there's a query per page and we have 5kish pages,  we would want to run this job once every 3 days (72 hrs) as the most frequent interval we could do 
  • Finish the Implementation of the right rail component on the docs site and generate related content links into pages. We are approved to do `60k searches/month (assuming 2k searches * 30 days)

NOTE: JV tested this out in #1356 so it seems to be working with static resource links in frontmatter.

  • Update the Style Guide to ensure we define how this feature works. we can pass this off to a Docs Writer, so let's create a content ticket and have @paperclypse review it.

  • There is a small bug when running the build for related resources which is why there are no pages with it currently. Right now you can run the build for related resources on demand, which will query Swiftype for all pages, but last I ran this it failed due to an error from the Swiftype API that we did not catch properly.

Mock Up

Screen Shot 2021-03-16 at 3 15 21 PM

@jpvajda jpvajda added the enhancement New feature or request label Mar 16, 2021
@jerelmiller
Copy link
Contributor

@jpvajda Technically this is implemented, but there is a small bug when running the build for related resources which is why there are no pages with it currently. Right now you can run the build for related resources on demand, which will query Swiftype for all pages, but last I ran this it failed due to an error from the Swiftype API that we did not catch properly.

@jpvajda
Copy link
Author

jpvajda commented Mar 17, 2021

@jerelmiller Thank you! I added this info to the AC.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants