{"_id":"56d06ccd167e1e1b00807973","project":"55faf11ba62ba1170021a9a7","category":{"_id":"5604570090ee490d00440551","__v":12,"version":"55faf11ba62ba1170021a9aa","pages":["56045766e5102a0d0070f96e","560457748d58900d0051eb38","560457968d58900d0051eb3a","560457a6188994170059ce87","560457b38d58900d0051eb3c","564270918c503f17002d6a1c","5642723db0dc090d00f884f1","56427319b0dc090d00f884f5","5667254066debc1700503f33","56d06ccd167e1e1b00807973","56d48956de40c70b00823e6a","56d82004c83c5f0b00d28721"],"project":"55faf11ba62ba1170021a9a7","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-09-24T20:03:12.010Z","from_sync":false,"order":3,"slug":"manage-an-analysis-environment","title":"MANAGE AN ANALYSIS ENVIRONMENT"},"user":"566590c83889610d0008a253","__v":12,"parentDoc":null,"version":{"_id":"55faf11ba62ba1170021a9aa","project":"55faf11ba62ba1170021a9a7","__v":38,"createdAt":"2015-09-17T16:58:03.490Z","releaseDate":"2015-09-17T16:58:03.490Z","categories":["55faf11ca62ba1170021a9ab","55faf8f4d0e22017005b8272","55faf91aa62ba1170021a9b5","55faf929a8a7770d00c2c0bd","55faf932a8a7770d00c2c0bf","55faf94b17b9d00d00969f47","55faf958d0e22017005b8274","55faf95fa8a7770d00c2c0c0","55faf96917b9d00d00969f48","55faf970a8a7770d00c2c0c1","55faf98c825d5f19001fa3a6","55faf99aa62ba1170021a9b8","55faf99fa62ba1170021a9b9","55faf9aa17b9d00d00969f49","55faf9b6a8a7770d00c2c0c3","55faf9bda62ba1170021a9ba","5604570090ee490d00440551","5637e8b2fbe1c50d008cb078","5649bb624fa1460d00780add","5671974d1b6b730d008b4823","5671979d60c8e70d006c9760","568e8eef70ca1f0d0035808e","56d0a2081ecc471500f1795e","56d4a0adde40c70b00823ea3","56d96b03dd90610b00270849","56fbb83d8f21c817002af880","573c811bee2b3b2200422be1","576bc92afb62dd20001cda85","5771811e27a5c20e00030dcd","5785191af3a10c0e009b75b0","57bdf84d5d48411900cd8dc0","57ff5c5dc135231700aed806","5804caf792398f0f00e77521","58458b4fba4f1c0f009692bb","586d3c287c6b5b2300c05055","58ef66d88646742f009a0216","58f5d52d7891630f00fe4e77","59a555bccdbd85001bfb1442"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-26T15:18:37.543Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":5,"body":"Project notes are a simple way for project members to exchange information or discuss ideas related to their project. All members within a project can add notes or comment on an existing note. Project notes are displayed within a panel which is easily accessible from the **Notes** tab. All notes display information about who created them and the date and time they were added.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"On this page:\",\n  \"body\": \"* [Access project notes](#access notes)\\n* [Create a note](#create a note)\\n* [Format a note using Markdown](#use markdown)\\n* [Examples of notes](#example of notes)\\n  * [Example of notes for a project](#notes for project)\\n  * [Example of notes for a page](#notes for a page)\\n  * [Example of notes for a specific file, task, or app](#notes for file)\"\n}\n[/block]\n<a name=\"access notes\"></a>\n##Access project notes\nTo access project notes, navigate to a desired project and choose the note's location.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Location-specific\",\n  \"body\": \"Notes are tied to specific locations within a project, such as the[ entire project](#notes for project); a [specific page](#notes for page); or a [specific app, file, or task](#notes for file).\"\n}\n[/block]\nOnce you are in your desired location, click the **Notes** tab in the upper right corner, as shown below.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/CGurPoI9RgChIhXQVWkj_notes%20-%20cgc1.jpg\",\n        \"notes - cgc1.jpg\",\n        \"952\",\n        \"408\",\n        \"#0954a1\",\n        \"\"\n      ],\n      \"border\": true,\n      \"caption\": \"Project notes\"\n    }\n  ]\n}\n[/block]\nThis opens the **Notes** panel (shown below) which displays notes and comments made by all project members.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/xdzQBvQRBeS2BiCjIc3D_cgcnotes2.jpeg\",\n        \"cgcnotes2.jpeg\",\n        \"2284\",\n        \"874\",\n        \"#1d4e84\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\nOnce you open the **Notes** panel, you can [create a new note](#create a note), edit an existing note, delete a note, or add a comment replying to a note.\n\n<div align=\"right\"><a href=\"#top\">top</a></div>\n\n<a name=\"create a note\"></a>\n##Create a note\nTo add a new note:\n1. [Navigate to your project](view-a-project).\n2. Choose a location for your note. Navigate to the project dashboard, a specific tab (e.g. the **Files** tab or the **Settings** tab), a specific part of a page (e.g. a specific file, app, or task).\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Location-specific\",\n  \"body\": \"Notes are tied to specific locations within a project, such as the[ entire project](#notes for project); a [specific page](#notes for page); or a [specific app, file, or task](#notes for file).\"\n}\n[/block]\n 3. After selecting the location, click the **Notes** tab in the upper right corner. This displays the **Notes** panel.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/uATPEGpQn2XqeHm6r92S_notes3.jpeg\",\n        \"notes3.jpeg\",\n        \"876\",\n        \"870\",\n        \"#3479b6\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n4. Click **Create new note**.\n5. Write your note.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/EuZfvONXSqiBmOeSsvBQ_notes4.jpeg\",\n        \"notes4.jpeg\",\n        \"888\",\n        \"634\",\n        \"#3b70a0\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"success\",\n  \"body\": \"You can use Markdown to [format your note](#use markdown).\",\n  \"title\": \"Format your note\"\n}\n[/block]\n6. Click **Post**.\n\nOnce you post a note or comment, all project members will receive an email notification with a link to the note's (or comment's) location. For example, if you add a note to a task, project members will receive an email notification with a link to that specific task. Your note (or comment) will be highlighted inside the **Notes** panel.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Auto-saved notes\",\n  \"body\": \"Your notes are auto-saved every few seconds. You can return to this draft version of your note at any point before your note is posted. You can also use the **Preview** button (shown in the image above) to see how the note will look before posting it.\"\n}\n[/block]\n<div align=\"right\"><a href=\"#top\">top</a></div>\n\n<a name=\"use markdown\"></a>\n##Format a note using markdowns\nYou can use markup to format the text for the note or a comment (e.g. you can make some words **bold** and other words *italic* with Markdown. <a href=\"https://michelf.ca/projects/php-markdown/extra/\" target=\"blank\">Other markup options are also available</a>).\n\nUsing markdown, you can also add an image to your note. To add an image:\n\n1. Make sure your image is already hosted online.\n2. Put the image url within the brackets of the following line:\n`![alt text](https://www.address.com/my-image.jpg)`\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/FqxNEMmuQ8mUD1YkLCfm_cgcnotes3.jpg\",\n        \"cgcnotes3.jpg\",\n        \"861\",\n        \"697\",\n        \"#234f81\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n<div align=\"right\"><a href=\"#top\">top</a></div>\n\n<a name=\"example of notes\"></a>\n##Examples of notes\nNotes are tied to specific locations within a project. See below for examples of notes added to:\n  * [the entire project](#notes for project)\n  * [a specific page](#notes for a page)\n  * [a specific app, file, or task](#notes for a file).\n<div align=\"right\"><a href=\"#top\">top</a></div>\n\n<a name=\"notes for project\"></a>\n###Example of notes for a project\nYou can display all notes in a project by accessing the **Notes** panel from the project dashboard, **Settings** tab, or the **Interactive Analysis** tab.\n\nBelow, you can see notes which were added to various locations, including **Settings**, the **Files** tab, and a single app. Each note includes a green tag denoting its location (e.g. **APP** or **FILES**). This tag is also a hyperlink to the note's location.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/4Isvl1iCTOWz9PnJInVS_cgcbites4.jpeg\",\n        \"cgcbites4.jpeg\",\n        \"2296\",\n        \"1560\",\n        \"#234c7a\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"You can increase the size of the **Notes** panel by dragging the left side towards the middle of the page.\"\n}\n[/block]\n\n<div align=\"right\"><a href=\"#top\">top</a></div>\n\n<a name=\"notes for a page\"></a>\n###Example of notes for a page\nYou can display notes for a specific page by accessing the **Notes** panel from the desired tab.\nFrom the **Files** tab in the example below, you can display all notes related to **Files** in the **Notes** panel. These are both the notes added to the **Files** page and the notes added to the individual files. Each note includes a green tag denoting its location (e.g. **FILES** for notes linked to the Files page or **FILE** for a single file). This tag is also a hyperlink to the note's location.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/QWWMp0ROSMKggfWHXdxc_cgcnotes5.jpeg\",\n        \"cgcnotes5.jpeg\",\n        \"2298\",\n        \"1150\",\n        \"#20528d\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\nThe same applies for the **Apps** and **Tasks** pages.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Use the switch in the upper left corner of the **Notes** panel to toggle between notes in your current location and all project notes. You can also increase the size of the **Notes** panel by dragging the left side towards the middle of the page.\",\n  \"title\": \"\"\n}\n[/block]\n<div align=\"right\"><a href=\"#top\">top</a></div>\n\n<a name=\"notes for file\"></a>\n###Example of notes for a specific file, task, or app\nYou can display all notes related to a single file, task, or app by accessing the **Notes** panel from the file, task, or app 's page. From the **Whole Exome Sequencing GATK 2.3.9.-lite** page below, you can display all notes relating to this specific app. Each note includes a green tag denoting its location (e.g. **APP**).\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/ubTqSvdWS4LtDk5xLx5i_cgcnotes6.jpeg\",\n        \"cgcnotes6.jpeg\",\n        \"2288\",\n        \"1016\",\n        \"#214a77\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\nThe same applies for individual files and tasks, which will have the related tag (e.g. **FILE** or **TASK**).\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Use the switch in the upper left corner of the **Notes** panel to toggle between notes in your current location and all project notes. You can also increase the size of the **Notes** panel by dragging the left side towards the middle of the page.\",\n  \"title\": \"\"\n}\n[/block]\n<div align=\"right\"><a href=\"#top\">top</a></div>","excerpt":"<a name=\"top\"></a>","slug":"add-notes-to-your-project","type":"basic","title":"Add notes to your project"}

Add notes to your project

<a name="top"></a>

Project notes are a simple way for project members to exchange information or discuss ideas related to their project. All members within a project can add notes or comment on an existing note. Project notes are displayed within a panel which is easily accessible from the **Notes** tab. All notes display information about who created them and the date and time they were added. [block:callout] { "type": "warning", "title": "On this page:", "body": "* [Access project notes](#access notes)\n* [Create a note](#create a note)\n* [Format a note using Markdown](#use markdown)\n* [Examples of notes](#example of notes)\n * [Example of notes for a project](#notes for project)\n * [Example of notes for a page](#notes for a page)\n * [Example of notes for a specific file, task, or app](#notes for file)" } [/block] <a name="access notes"></a> ##Access project notes To access project notes, navigate to a desired project and choose the note's location. [block:callout] { "type": "info", "title": "Location-specific", "body": "Notes are tied to specific locations within a project, such as the[ entire project](#notes for project); a [specific page](#notes for page); or a [specific app, file, or task](#notes for file)." } [/block] Once you are in your desired location, click the **Notes** tab in the upper right corner, as shown below. [block:image] { "images": [ { "image": [ "https://files.readme.io/CGurPoI9RgChIhXQVWkj_notes%20-%20cgc1.jpg", "notes - cgc1.jpg", "952", "408", "#0954a1", "" ], "border": true, "caption": "Project notes" } ] } [/block] This opens the **Notes** panel (shown below) which displays notes and comments made by all project members. [block:image] { "images": [ { "image": [ "https://files.readme.io/xdzQBvQRBeS2BiCjIc3D_cgcnotes2.jpeg", "cgcnotes2.jpeg", "2284", "874", "#1d4e84", "" ] } ] } [/block] Once you open the **Notes** panel, you can [create a new note](#create a note), edit an existing note, delete a note, or add a comment replying to a note. <div align="right"><a href="#top">top</a></div> <a name="create a note"></a> ##Create a note To add a new note: 1. [Navigate to your project](view-a-project). 2. Choose a location for your note. Navigate to the project dashboard, a specific tab (e.g. the **Files** tab or the **Settings** tab), a specific part of a page (e.g. a specific file, app, or task). [block:callout] { "type": "info", "title": "Location-specific", "body": "Notes are tied to specific locations within a project, such as the[ entire project](#notes for project); a [specific page](#notes for page); or a [specific app, file, or task](#notes for file)." } [/block] 3. After selecting the location, click the **Notes** tab in the upper right corner. This displays the **Notes** panel. [block:image] { "images": [ { "image": [ "https://files.readme.io/uATPEGpQn2XqeHm6r92S_notes3.jpeg", "notes3.jpeg", "876", "870", "#3479b6", "" ] } ] } [/block] 4. Click **Create new note**. 5. Write your note. [block:image] { "images": [ { "image": [ "https://files.readme.io/EuZfvONXSqiBmOeSsvBQ_notes4.jpeg", "notes4.jpeg", "888", "634", "#3b70a0", "" ] } ] } [/block] [block:callout] { "type": "success", "body": "You can use Markdown to [format your note](#use markdown).", "title": "Format your note" } [/block] 6. Click **Post**. Once you post a note or comment, all project members will receive an email notification with a link to the note's (or comment's) location. For example, if you add a note to a task, project members will receive an email notification with a link to that specific task. Your note (or comment) will be highlighted inside the **Notes** panel. [block:callout] { "type": "info", "title": "Auto-saved notes", "body": "Your notes are auto-saved every few seconds. You can return to this draft version of your note at any point before your note is posted. You can also use the **Preview** button (shown in the image above) to see how the note will look before posting it." } [/block] <div align="right"><a href="#top">top</a></div> <a name="use markdown"></a> ##Format a note using markdowns You can use markup to format the text for the note or a comment (e.g. you can make some words **bold** and other words *italic* with Markdown. <a href="https://michelf.ca/projects/php-markdown/extra/" target="blank">Other markup options are also available</a>). Using markdown, you can also add an image to your note. To add an image: 1. Make sure your image is already hosted online. 2. Put the image url within the brackets of the following line: `![alt text](https://www.address.com/my-image.jpg)` [block:image] { "images": [ { "image": [ "https://files.readme.io/FqxNEMmuQ8mUD1YkLCfm_cgcnotes3.jpg", "cgcnotes3.jpg", "861", "697", "#234f81", "" ] } ] } [/block] <div align="right"><a href="#top">top</a></div> <a name="example of notes"></a> ##Examples of notes Notes are tied to specific locations within a project. See below for examples of notes added to: * [the entire project](#notes for project) * [a specific page](#notes for a page) * [a specific app, file, or task](#notes for a file). <div align="right"><a href="#top">top</a></div> <a name="notes for project"></a> ###Example of notes for a project You can display all notes in a project by accessing the **Notes** panel from the project dashboard, **Settings** tab, or the **Interactive Analysis** tab. Below, you can see notes which were added to various locations, including **Settings**, the **Files** tab, and a single app. Each note includes a green tag denoting its location (e.g. **APP** or **FILES**). This tag is also a hyperlink to the note's location. [block:image] { "images": [ { "image": [ "https://files.readme.io/4Isvl1iCTOWz9PnJInVS_cgcbites4.jpeg", "cgcbites4.jpeg", "2296", "1560", "#234c7a", "" ] } ] } [/block] [block:callout] { "type": "info", "body": "You can increase the size of the **Notes** panel by dragging the left side towards the middle of the page." } [/block] <div align="right"><a href="#top">top</a></div> <a name="notes for a page"></a> ###Example of notes for a page You can display notes for a specific page by accessing the **Notes** panel from the desired tab. From the **Files** tab in the example below, you can display all notes related to **Files** in the **Notes** panel. These are both the notes added to the **Files** page and the notes added to the individual files. Each note includes a green tag denoting its location (e.g. **FILES** for notes linked to the Files page or **FILE** for a single file). This tag is also a hyperlink to the note's location. [block:image] { "images": [ { "image": [ "https://files.readme.io/QWWMp0ROSMKggfWHXdxc_cgcnotes5.jpeg", "cgcnotes5.jpeg", "2298", "1150", "#20528d", "" ] } ] } [/block] The same applies for the **Apps** and **Tasks** pages. [block:callout] { "type": "info", "body": "Use the switch in the upper left corner of the **Notes** panel to toggle between notes in your current location and all project notes. You can also increase the size of the **Notes** panel by dragging the left side towards the middle of the page.", "title": "" } [/block] <div align="right"><a href="#top">top</a></div> <a name="notes for file"></a> ###Example of notes for a specific file, task, or app You can display all notes related to a single file, task, or app by accessing the **Notes** panel from the file, task, or app 's page. From the **Whole Exome Sequencing GATK 2.3.9.-lite** page below, you can display all notes relating to this specific app. Each note includes a green tag denoting its location (e.g. **APP**). [block:image] { "images": [ { "image": [ "https://files.readme.io/ubTqSvdWS4LtDk5xLx5i_cgcnotes6.jpeg", "cgcnotes6.jpeg", "2288", "1016", "#214a77", "" ] } ] } [/block] The same applies for individual files and tasks, which will have the related tag (e.g. **FILE** or **TASK**). [block:callout] { "type": "info", "body": "Use the switch in the upper left corner of the **Notes** panel to toggle between notes in your current location and all project notes. You can also increase the size of the **Notes** panel by dragging the left side towards the middle of the page.", "title": "" } [/block] <div align="right"><a href="#top">top</a></div>