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

Added detailed pages for each backend API and completed documentatio… #3

Merged
merged 2 commits into from
May 27, 2024

Conversation

HarshitaShroff
Copy link
Contributor

Updates to the Ontrack documentation website

Description

Changes include detailed pages for each backend doubtfire API and completed documentation for API_Set1

  • activity_types
  • auth
  • campuses
  • csv
  • settings
  • students
  • teaching_periods

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 May 13, 2024

Deploy Preview for ontrackdocumentation ready!

Name Link
🔨 Latest commit cf960e8
🔍 Latest deploy log https://app.netlify.com/sites/ontrackdocumentation/deploys/664581f40e89090009053e88
😎 Deploy Preview https://deploy-preview-3--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.

@DudeUnleashed
Copy link
Collaborator

image
The underscore for the activity_types overviews are missing, otherwise this section i feel is complete

Missing '/auth/jwt' endpoints under the auth category

Campuses is complete

image
Username could have a better description - suggestion: "Username of the user"
Otherwise everything seems covered

Settings is complete
Students is complete

image
Delete teaching period has a markdown error for the parameters table
Otherwise seems correct

…added auth/jwt), format updated for teaching_period
@HarshitaShroff
Copy link
Contributor Author

I have addressed the above feedback and suggestion.

Activity types: added the underscore for the activity_types overviews.
Auth: Added '/auth/jwt' endpoints under the auth category
Csv: updated the username description
Teaching_period: Updated the format for DELETE operation

@DudeUnleashed
Copy link
Collaborator

Re-reviewed the documentation and all seems correct, changes listed previously addressed.

@aNebula aNebula merged commit 2d5afe3 into thoth-tech:main May 27, 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.

3 participants