Challenge Overview
Currently, in Topcoder Direct, it is using CKEditor (http://ckeditor.com/) for rich content editing, like for Detail Requirements section, Submission Guidelines.
For this challenge, we'd like to see the possilbity to provide a option to use markdown for drafting challenges in Topcoder direct. Here are the expected functionality.
You just need to cover Develop challegnes, Design challenge will be handled later.
When Launching New Challenge
1. this is related to the launch challenge page - https://www.topcoder.com/direct/launch/home
2. for the Detailed Requirements and Submissions Guidelines sections, there will be checkbox shown next to the Section title to choose if we want to use Markdown Style document, by the default, it will use the existing CKEditor.
3. If the checkbox is selected, the CKEditor will be hidden, and another form which support Markdown Documentation will be shown for editing. Please use CodeMirror with Markdown mode
4. If the checkbox is unselected, it will switch back to the original CKEditor, and the functionality should be remained as existing implementation.
5. For DB storage, we need to add new fields to indicate if these fields are used Markdown style or not, please add these fields, if you have a better approach for distingushing, please send emails to skyhit at gmail.com for approval.
When View Challenge
1. this is related to page like https://www.topcoder.com/direct/contest/detail.action?projectId=xxxxx
2. When in view mode, the markdown should be properly translated to html for displaying, you can use libraries like https://github.com/evilstreak/markdown-js
3. The Edit button related logic are not included in this challenge.
How to Run Direct App Locally
Please follow https://github.com/appirio-tech/tc-common-tutorials/tree/master/docker/direct-app to build and run direct app locally, make sure you can create projects, challenges, and nothing is broken.
- DB changes
- Deployment guide and verification steps
For this challenge, we'd like to see the possilbity to provide a option to use markdown for drafting challenges in Topcoder direct. Here are the expected functionality.
You just need to cover Develop challegnes, Design challenge will be handled later.
When Launching New Challenge
1. this is related to the launch challenge page - https://www.topcoder.com/direct/launch/home
2. for the Detailed Requirements and Submissions Guidelines sections, there will be checkbox shown next to the Section title to choose if we want to use Markdown Style document, by the default, it will use the existing CKEditor.
3. If the checkbox is selected, the CKEditor will be hidden, and another form which support Markdown Documentation will be shown for editing. Please use CodeMirror with Markdown mode
4. If the checkbox is unselected, it will switch back to the original CKEditor, and the functionality should be remained as existing implementation.
5. For DB storage, we need to add new fields to indicate if these fields are used Markdown style or not, please add these fields, if you have a better approach for distingushing, please send emails to skyhit at gmail.com for approval.
When View Challenge
1. this is related to page like https://www.topcoder.com/direct/contest/detail.action?projectId=xxxxx
2. When in view mode, the markdown should be properly translated to html for displaying, you can use libraries like https://github.com/evilstreak/markdown-js
3. The Edit button related logic are not included in this challenge.
How to Run Direct App Locally
Please follow https://github.com/appirio-tech/tc-common-tutorials/tree/master/docker/direct-app to build and run direct app locally, make sure you can create projects, challenges, and nothing is broken.
Final Submission Guidelines
- Code Changes to Support Markdown for Develop Challenges- DB changes
- Deployment guide and verification steps