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

Usage Notes: Document format of profiles.json #626

Merged
merged 13 commits into from
Mar 12, 2021
Merged

Usage Notes: Document format of profiles.json #626

merged 13 commits into from
Mar 12, 2021

Conversation

seanlowjk
Copy link
Contributor

Summary

This PR fixes #584, which adds a section on the format of profiles.json to be supplied.

Description

You can see the actual visual changes here

Proposed Commit Message

Dev Notes: Add section on E2E tests

We do not have the expected format of profiles.json 
documented. 

Let's document the expected format of
'profiles.json' under Usage Notes so that future users
will be able to supply a correct file format to load
custom sessions.

@seanlowjk seanlowjk requested a review from a team March 7, 2021 07:54
kkangs0226
kkangs0226 reviewed Mar 7, 2021
View reviewed changes
Copy link
Contributor

@kkangs0226 kkangs0226 left a comment

Choose a reason for hiding this comment

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

I see no issues with the documentation, LGTM!:)

dingyuchen
dingyuchen reviewed Mar 7, 2021
View reviewed changes
Copy link
Contributor

@dingyuchen dingyuchen left a comment

Choose a reason for hiding this comment

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

LGTM! Just some small comments

docs/usage-notes.md Outdated

`profileName` refers to the profile name displayed in the session select page. `encodedText` refers to the repository which stores the required settings for your custom session.

> **Note**: You **must** have both of these fields in each `Profile` and no extra unnecessary fields! Else, the `profile.json` file that you have supplied will not be parsed successfully.
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm currently not checking for unnecessary fields, should we add that functionality in?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah alright, I think we can leave it out for now!

When we actually check for unnecessary fields, then one of us can update the dev notes whenever necessary!

docs/usage-notes.md Outdated

`profileName` refers to the profile name displayed in the session select page. `encodedText` refers to the repository which stores the required settings for your custom session.

> **Note**: You **must** have both of these fields in each `Profile` and no extra unnecessary fields! Else, the `profile.json` file that you have supplied will not be parsed successfully.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think it'll be good to also state explicitly "no empty string" for field values.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

👍

@codecov-io
Copy link

codecov-io commented Mar 7, 2021 •
edited

Codecov Report

Merging #626 (3ae68ca) into master (686dd65) will decrease coverage by 0.09%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #626      +/-   ##
==========================================
- Coverage   67.59%   67.50%   -0.10%     
==========================================
  Files          72       72              
  Lines        2160     2160              
  Branches      198      198              
==========================================
- Hits         1460     1458       -2     
  Misses        660      660              
- Partials       40       42       +2
Impacted Files Coverage Δ
src/app/shared/issue-tables/issue-sorter.ts 44.00% <0.00%> (-8.00%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 686dd65...3ae68ca. Read the comment docs.

anubh-v
anubh-v reviewed Mar 8, 2021
View reviewed changes
Copy link
Contributor

@anubh-v anubh-v left a comment

Choose a reason for hiding this comment

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

Looks good, just some brief comments

docs/usage-notes.md Outdated Show resolved Hide resolved
docs/usage-notes.md Outdated Show resolved Hide resolved
@seanlowjk
Copy link
Contributor Author

Have moved it into a separate section by itself!

Screenshot from 2021-03-09 18-38-10

Screenshot from 2021-03-09 18-38-27

ptvrajsk
ptvrajsk reviewed Mar 10, 2021
View reviewed changes
Copy link
Contributor

@ptvrajsk ptvrajsk left a comment

Choose a reason for hiding this comment

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

Looks mostly good! Just some minor queries. 👍

docs/usage-notes.md Outdated Show resolved Hide resolved
docs/usage-notes.md Outdated Show resolved Hide resolved
docs/usage-notes.md Outdated Show resolved Hide resolved
seanlowjk and others added 2 commits March 10, 2021 16:05
@seanlowjk @ptvrajsk
Fix Typo
3ae68ca 
Co-authored-by: ptvrajsk <39243082+ptvrajsk@users.noreply.github.com>
@seanlowjk
Add Details to File and encodedText format
ca99ed6
anubh-v
anubh-v approved these changes Mar 11, 2021
View reviewed changes
Copy link
Contributor

@anubh-v anubh-v left a comment

Choose a reason for hiding this comment

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

Looks good 👍
@CATcher-org/2021-devs any further comments by anyone?

@anubh-v anubh-v merged commit bbf4dad into CATcher-org:master Mar 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dingyuchen dingyuchen dingyuchen left review comments

@ptvrajsk ptvrajsk ptvrajsk left review comments

@kkangs0226 kkangs0226 kkangs0226 left review comments

@anubh-v anubh-v anubh-v approved these changes

Assignees
No one assigned
Labels
s.ToMerge
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Usage notes: Document format of 'profiles.json'
6 participants
@seanlowjk @codecov-io @dingyuchen @anubh-v @ptvrajsk @kkangs0226