The HTML appendix generated by the yard-appendix plugin contains
HTML tags that cannot be rendered correctly by the Markdown
renderer. This patch set fixes the rendering of the appendices by
generating Markdown format components instead of HTML.
refs: SAS-3699
How to generate the docs in Markdown format?
Run this command from a Canvas box:
`OUTPUT_FORMAT=markdown rake doc:api`
The generated documentation will be available in `public/doc/api_md`.
Tests executed:
- Backward compatibility: I regenerated the documentation in HTML format
and compared each file with the output from an original documentation.
Only the timestamps in the footer differed; everything else was the same.
- Content parity: I compared the content of each generated Markdown file
with its "twin brother" HTML file. While there are differences in look and
feel, the content is consistent. This is how it looks like in Markdown
format:
https://inst.gitbook.io/sandbox-instructure-developer-portal/0hk9uatQ63bsQYSzZzF2/services/api
Note:
The change does not influence in any way the HTML formatted
Canvas Documentation or the way is generated.
Change-Id: Ie545effcee651a23b69b22723bfcb4ddfb319515
Reviewed-on: https://gerrit.instructure.com/c/canvas-lms/+/358068
Tested-by: Service Cloud Jenkins <svc.cloudjenkins@instructure.com>
Reviewed-by: Tucker Mcknight <tmcknight@instructure.com>
QA-Review: Tucker Mcknight <tmcknight@instructure.com>
Product-Review: Jozsef Kercso <jozsef.kercso@instructure.com>
Warning messages in HTML format uses a CSS style which cannot
be interpreted by the Markdown renderer. I changed them to
Markdown specific warning messages.
Also, definition lists <dl> were converted to unordered lists <ul>
because <dl> is not a Markdown compatible HTML tag.
refs: SAS-3699
How to generate the docs in Markdown format?
Run this command from a Canvas box:
`OUTPUT_FORMAT=markdown rake doc:api`
The generated documentation will be available in `public/doc/api_md`.
Tests executed:
- Backward compatibility: I regenerated the documentation in HTML format
and compared each file with the output from an original documentation.
Only the timestamps in the footer differed; everything else was the same.
- Content parity: I compared the content of each generated Markdown file
with its "twin brother" HTML file. While there are differences in look and
feel, the content is consistent. This is how it looks like in Markdown
format:
https://inst.gitbook.io/sandbox-instructure-developer-portal/0hk9uatQ63bsQYSzZzF2/services/api
Note:
The change does not influence in any way the HTML formatted
Canvas Documentation or the way is generated.
Change-Id: Idb8eb7e69cb7a9e790bf1a738fa5fe9886be328b
Reviewed-on: https://gerrit.instructure.com/c/canvas-lms/+/358069
Tested-by: Service Cloud Jenkins <svc.cloudjenkins@instructure.com>
Reviewed-by: Tucker Mcknight <tmcknight@instructure.com>
QA-Review: Tucker Mcknight <tmcknight@instructure.com>
Product-Review: Jozsef Kercso <jozsef.kercso@instructure.com>
closes EGG-32
flag=restrict_quantitative_data
test plan:
- Enable Restrict view of quantitative data in
Account Settings
- Create a Course an Enable
Restrict view of quantitative data in Account Settings
- Create a Discussion
- Enable 'Graded'
- Validate that 'Assign graded checkpoints' is not shown
- Save the changes
- Edit the discussion
- Enable 'Graded'
- Validate that 'Assign graded checkpoints' is not shown
Change-Id: Ieb2d4f2ed29375ed24930f64b094b7b22eed17e7
Reviewed-on: https://gerrit.instructure.com/c/canvas-lms/+/358061
Reviewed-by: Jason Gillett <jason.gillett@instructure.com>
QA-Review: Omar Soto-Fortuño <omar.soto@instructure.com>
Tested-by: Service Cloud Jenkins <svc.cloudjenkins@instructure.com>
Product-Review: Sam Garza <sam.garza@instructure.com>
this commit adds the needed mutation modifications to the canvas repo
so that it can be used by the comment library bank in sg2
closes EVAL-3866
flag=platform_service_speedgrader
test plan:
- build passes
Change-Id: I70c2d44941bbdacfa2c4f7811f5debd182650110
Reviewed-on: https://gerrit.instructure.com/c/canvas-lms/+/358316
Reviewed-by: Cameron Ray <cameron.ray@instructure.com>
Tested-by: Service Cloud Jenkins <svc.cloudjenkins@instructure.com>
QA-Review: Chris Soto <christopher.soto@instructure.com>
Product-Review: Chris Soto <christopher.soto@instructure.com>
refs EVAL-4655
flag=platform_service_speedgrader
Test plan
- SG2 loads for normal assignments
- Original speedgrader loads for anonymous assignment
- Original speedgrader loads for assignment with moderated grading
Change-Id: Ic170cba79cc9e43c70c8f4a6ac00fb7fe5473390
Reviewed-on: https://gerrit.instructure.com/c/canvas-lms/+/358311
Reviewed-by: Spencer Olson <solson@instructure.com>
Tested-by: Service Cloud Jenkins <svc.cloudjenkins@instructure.com>
QA-Review: Cameron Ray <cameron.ray@instructure.com>
Product-Review: Cameron Ray <cameron.ray@instructure.com>
closes VICE-4434
flag=discussion_checkpoints
Test plan:
- Test passes
- Go to Screen Reader Grade Book and try grading
different types of checkpoints, it should work
and persist as expected.
Change-Id: If37afc92f62b76f14b518a1a1cb84e2eb74f1256
Reviewed-on: https://gerrit.instructure.com/c/canvas-lms/+/358144
Tested-by: Service Cloud Jenkins <svc.cloudjenkins@instructure.com>
Reviewed-by: Spencer Olson <solson@instructure.com>
Reviewed-by: Chris Soto <christopher.soto@instructure.com>
QA-Review: Jason Gillett <jason.gillett@instructure.com>
Product-Review: Sam Garza <sam.garza@instructure.com>
refs RCX-2417
flag=none
Test plan:
- Get media into notorious but not instfs
- Downloads shouldnt be working from the files page (nor previews)
- Run the datafix
- Check that all of them made their way into intfs
Change-Id: I7d419824bc44338704fd60b22b842d18bea152ac
Reviewed-on: https://gerrit.instructure.com/c/canvas-lms/+/358040
Reviewed-by: Mysti Lilla <mysti@instructure.com>
Tested-by: Service Cloud Jenkins <svc.cloudjenkins@instructure.com>
QA-Review: Mysti Lilla <mysti@instructure.com>
Product-Review: Luis Oliveira <luis.oliveira@instructure.com>
Jacob Burroughs