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.

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

Write feed-discovery documentation #3146

Merged
merged 1 commit into from
Mar 9, 2022
Merged

Write feed-discovery documentation #3146

merged 1 commit into from
Mar 9, 2022

Conversation

JerryHue
Copy link
Contributor

@JerryHue JerryHue commented Mar 8, 2022

Issue This PR Addresses

#203 (this one documents the feed-discovery service only)

Type of Change

  • Bugfix: Change which fixes an issue
  • New Feature: Change which adds functionality
  • Documentation Update: Change which improves documentation
  • UI: Change which improves UI

Description

This PR expands the documentation for the feed-discovery service.

The structure used in similar to the GitHub REST API docs.

Steps to test the PR

  1. Pull my changes
  2. Go to the docs (cd src/docs)
  3. Start docusaurus locally (pnpm start)

Checklist

  • Quality: This PR builds and passes our npm test and works locally
  • Tests: This PR includes thorough tests or an explanation of why it does not
  • Screenshots: This PR includes screenshots or GIFs of the changes made or an explanation of why it does not (if applicable)
  • Documentation: This PR includes updated/added documentation to user exposed functionality.

@JerryHue JerryHue added type: documentation (docs) Improvements or additions to documentation review: easy labels Mar 8, 2022
@JerryHue JerryHue added this to the 2.8 Release milestone Mar 8, 2022
@JerryHue JerryHue self-assigned this Mar 8, 2022
@gitpod-io
Copy link

gitpod-io bot commented Mar 8, 2022

humphd
humphd requested changes Mar 8, 2022
View reviewed changes
Copy link
Contributor

@humphd humphd left a comment

Choose a reason for hiding this comment

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

Love it, a few things.

src/docs/docs/api-services/feed-discovery.md Show resolved Hide resolved
src/docs/docs/api-services/feed-discovery.md Outdated Show resolved Hide resolved
@JerryHue JerryHue requested a review from humphd March 8, 2022 22:50
humphd
humphd previously approved these changes Mar 8, 2022
View reviewed changes
@aserputov aserputov self-requested a review March 8, 2022 23:37
aserputov
aserputov previously approved these changes Mar 8, 2022
View reviewed changes
@tpmai22
Copy link
Contributor

tpmai22 commented Mar 9, 2022

@JerryHue Let's squash and rebase it and I think we are good to go !

@JerryHue JerryHue dismissed stale reviews from aserputov and humphd via 82baa68 March 9, 2022 01:32
@JerryHue JerryHue force-pushed the feed-discovery-docs branch from 77955d9 to 82baa68 Compare March 9, 2022 01:32
@JerryHue JerryHue requested review from humphd and aserputov March 9, 2022 01:32
@tpmai22 tpmai22 force-pushed the feed-discovery-docs branch from 82baa68 to 4657e2e Compare March 9, 2022 03:28
@tpmai22 tpmai22 merged commit 8d54421 into Seneca-CDOT:master Mar 9, 2022
@JerryHue JerryHue mentioned this pull request Mar 23, 2022
Closed
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@DukeManh DukeManh DukeManh approved these changes

@tpmai22 tpmai22 tpmai22 approved these changes

@humphd humphd humphd approved these changes

@sirinoks sirinoks Awaiting requested review from sirinoks

@cindyorangis cindyorangis Awaiting requested review from cindyorangis

@aserputov aserputov Awaiting requested review from aserputov

Assignees

@JerryHue JerryHue

Labels
type: documentation (docs) Improvements or additions to documentation
Projects
None yet
Milestone
2.8 Release
Development

Successfully merging this pull request may close these issues.
5 participants
@JerryHue @tpmai22 @humphd @DukeManh @aserputov