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

API Detailed Operations Tutorial Streams and Group Sets #10

Merged
merged 16 commits into from
Sep 18, 2024

Conversation

Shyamachandran
Copy link
Contributor

Description

Please include a summary of the change and which issue is fixed. Please also include relevant
motivation and context. List any dependencies that are required for this change.

Fixes # (issue)

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as
    expected)
  • Documentation (update or new)

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can
reproduce. Please also list any relevant details for your test configuration

Testing Checklist

  • Tested in latest Chrome
  • Tested in latest Safari
  • Tested in latest Firefox

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have requested a review from ... on the Pull Request

Copy link

netlify bot commented Aug 1, 2024

Deploy Preview for ontrackdocumentation ready!

Name Link
🔨 Latest commit 009879f
🔍 Latest deploy log https://app.netlify.com/sites/ontrackdocumentation/deploys/66e928e213b35d00088b9fb8
😎 Deploy Preview https://deploy-preview-10--ontrackdocumentation.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 configuration.

Copy link
Contributor

@minusunil minusunil left a comment

Choose a reason for hiding this comment

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

Can you please format the file using prettier

@Shyamachandran
Copy link
Contributor Author

Hi Minu, Thanks for your review.
I have updated the file with appropriate formatting.

Copy link
Contributor

@minusunil minusunil left a comment

Choose a reason for hiding this comment

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

Hey Shyama, I've reviewed the changes you've made, and they are clear and good

Copy link
Collaborator

@DudeUnleashed DudeUnleashed left a comment

Choose a reason for hiding this comment

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

Hi Shyama, there's a few problems with the formatting of the page, and names of some of your parameters as mentioned in my various comments, however the endpoints, requests and everything else seem correct.

src/content/docs/backend/API/unit-tutorial_streams.md Outdated Show resolved Hide resolved
src/content/docs/backend/API/unit-tutorial_streams.md Outdated Show resolved Hide resolved
src/content/docs/backend/API/unit-tutorial_streams.md Outdated Show resolved Hide resolved
package-lock.json Outdated Show resolved Hide resolved
Copy link
Collaborator

@DudeUnleashed DudeUnleashed left a comment

Choose a reason for hiding this comment

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

The changes I requested have been made, everything looks good. The package-lock.json seems to be a bunch of updates, not sure if this needs to be done or ignored for the future.

Copy link
Contributor

@minusunil minusunil left a comment

Choose a reason for hiding this comment

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

Operations of "group_sets" API endpoints looks good, and formatting is also done

Copy link
Contributor

@minusunil minusunil left a comment

Choose a reason for hiding this comment

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

Documentation for these endpoints looks good and clear

@aNebula
Copy link
Collaborator

aNebula commented Sep 3, 2024

The changes I requested have been made, everything looks good. The package-lock.json seems to be a bunch of updates, not sure if this needs to be done or ignored for the future.

package-lock.json are to be committed, as they lock the versions of the dependencies. Thanks for the thorough review.

Copy link
Collaborator

@aNebula aNebula left a comment

Choose a reason for hiding this comment

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

Please remove the merge conflict from astro.config.mjs

astro.config.mjs Outdated
Comment on lines 158 to 170
<<<<<<< HEAD
label: 'Tutorial Streams',
link: '/backend/api/Unit-Tutorial Streams.md',
},
{
label: 'Group sets',
=======
label: 'Unit Tutorial Streams',
link: '/backend/api/unit-tutorial_streams',
},
{
label: 'Unit Group Sets',
>>>>>>> 07d8b8ad5447c02473126889dd785e6219e6c300
Copy link
Collaborator

Choose a reason for hiding this comment

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

@Shyamachandran this is merge conflict - please remove this and get a re-review from @DudeUnleashed .

Copy link
Collaborator

Choose a reason for hiding this comment

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

Change the PR title too please.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hello Nebula, Thank you for your review.
I have made the necessary changes and is ready for your review.
@DudeUnleashed - Please review revised version.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi Nebula,
This is all done now. All conflicts addressed.

@Shyamachandran Shyamachandran changed the title Sh/ap iupdate API Detailed Operations Tutorial Streams and Group Sets Sep 3, 2024
Copy link
Collaborator

@DudeUnleashed DudeUnleashed left a comment

Choose a reason for hiding this comment

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

There are some adjustments to be made, mainly for clarity on some of the parameters, and one formatting error for a response, all have been commented on, please take a look and see what you think.

src/content/docs/backend/API/unit-group_sets.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@DudeUnleashed DudeUnleashed left a comment

Choose a reason for hiding this comment

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

Everything that i brought up in previous review has been looked at, the deployment preview looks good for this section. Good work.

@DudeUnleashed
Copy link
Collaborator

@Shyamachandran There is a conflict you have to address first in the astro.config.mjs, please fix these and then we can move forward, thanks.

@Shyamachandran
Copy link
Contributor Author

Hi Jake,
Conflicts resolved.

@aNebula aNebula merged commit 4973907 into thoth-tech:main Sep 18, 2024
5 checks passed
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

Successfully merging this pull request may close these issues.

4 participants