Skip to content

fix fql references in docs #3761

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Nov 7, 2022
Merged

fix fql references in docs #3761

merged 3 commits into from
Nov 7, 2022

Conversation

ranand
Copy link

@ranand ranand commented Nov 4, 2022 •
edited
Loading

Proposed changes

  • We recently got the following comment from a different PM
- When looking at the information around FQL, I found the information architecture to be a bit off, I don’t know if this would be in y’all’s court or maybe Public API team?
  - Destination Filters [docs](https://segment.com/docs/connections/destinations/destination-filters/) reference FQL, which links to>
  - An FQL page contained within the [Segment docs section for Config API docs](https://segment.com/docs/api/config-api/fql/), which points to the fact that Public API is available, and also links to the config api docs>
  - However it says full filter reference docs can be found in the [main config api reference](https://reference.segmentapis.com/#6c12fbe8-9f84-4a6c-848e-76a2325cb3c5) material (which we can assume will be deprecated at some point in favor of Public API?), which also has a link to ‘more detailed documentation including a list of all operators and functions’, which links to>
  - [an empty page](https://segment.com/docs/config-api/fql)
additionally, the [Public API docs](https://docs.segmentapis.com/) have no reference to FQL that I can find, and does not replicate the important FQL language structure that is seen in the config api docs
  • In order to fix the above:
    • FQL references should be moved under PAPI from Config API
    • Fixing couple of broken links (also making changes to the public-api repo)

Merge timing

  • ASAP once approved?

@ranand ranand requested review from stayseesong, markzegarelli and a team as code owners November 4, 2022 06:12
@netlify
Copy link

netlify bot commented Nov 4, 2022

✅ Deploy Preview for segment-docs ready!

Name Link
🔨 Latest commit c217a53
🔍 Latest deploy log https://app.netlify.com/sites/segment-docs/deploys/6364ad590157ee00098596c2
😎 Deploy Preview https://deploy-preview-3761--segment-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@markzegarelli markzegarelli removed request for a team and stayseesong November 4, 2022 15:56
@ranand ranand changed the title Main fix fql references fix fql references in docs Nov 4, 2022
@markzegarelli markzegarelli merged commit a3779ca into develop Nov 7, 2022
@markzegarelli markzegarelli deleted the main_fix_fql_references branch November 7, 2022 17:05
@markzegarelli markzegarelli added the back-end fixes or updates to the site itself, which should not go in release notes label Nov 7, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Nov 7, 2022

Thank you for your contribution! Your pull request is merged, but may take a day or two to appear on the site.

@markzegarelli markzegarelli mentioned this pull request Jan 4, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@markzegarelli markzegarelli markzegarelli approved these changes

Assignees
No one assigned
Labels
back-end fixes or updates to the site itself, which should not go in release notes
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ranand @markzegarelli