User editable notes for VM and node (wiki?) #98
Comments
|
Feature requested by Alfa Centauri. |
|
Don't forget about templates if implemented as a new API call. |
Change was done because we wanted to be consistent with other object that has note (like snapshots, IPs, etc).
Updated node functionality (API, GUI) to be able to save notes. Updated migration so the note is save in DB.
|
Functionality will be done in two phases. The first phase is going to 2.6.0 release and will contain new text DB fields for VM and node to store note. Updated functionality in API calls: vm/define and node/define to be able to store, show note. GUI has been amended to show this new fields via API calls. Currently, we support only plain text that is escaped. The second phase will be in 2.7.0 release and will contain text field formatting in some reasonable format. We need to research some JavaScript library, that can format either ReStructured Text, Markdown, or some wiki engine and the user can store formatted text notes, that will be displayed nicely in the GUI (don't forget API validation!). Additionally, add a new screen that can display long text block, and note in details page should be truncated with a link to this new screen. |
I have also change order of the issues, to be accoring issue numbers from low to high.
The first phase of issue #98 and contain: * new text DB fields (with migration) for VM and node to store note * updated functionality in API calls: `vm/define -note <text>` and `node/define -note <text>` to be able to store, show note * GUI has been amended to show this new fields via API calls * Currently, we support only plain text that is escaped * Updated change log with issue #98 (ordered issues numerically)
|
The first phase has been done and is part of 2.6.0. See #98 (comment) |
We shall let users know that they can use markdown so I have updated the field note. When there is focus on the text area field it gets larger so is is easier to edit the text.
This way we can escape html, and more importantly javascript in order to prevent XSS, but have nice formatable notes. Added link to github issue #98 PR #214 in Changelog Our new template tag markdownify will handle escaping and also marking string safe so there is no need to have safe in template again. Added new class for markdownify table as other changes were breaking design. Fixed CSS long word wrapping problem. Updated view details to have markhown class that can be styled if necessary... Updated javascript to improoved UX in issue #98 and PR #214. We shall let users know that they can use markdown so I have updated the field note. When there is focus on the text area field it gets larger so is is easier to edit the text.
|
The second phase has been finished and merged in PR #214 |
The data (notes) can be stored in existing json fields in DB.
The text was updated successfully, but these errors were encountered: