Using Project Wiki
==================
Each Neptune project has a built-in Wiki. The Wiki is a collaborative space for developing and sharing reports, insights, and remarks
about the project's progress, experiments and data exploration Notebooks.
Create a Wiki page
------------------
1. Enter the relevant project.
2. Click the **Wiki** tab.
3. Click the **+** button:
.. image:: ../_static/images/organizing-and-exploring-results-in-the-ui/wiki/new_wiki_page.png
:target: ../_static/images/organizing-and-exploring-results-in-the-ui/wiki/new_wiki_page.png
:alt: Create new Wiki page
:width: 200
4. Type in the name of the new page.
5. Click **Save**.
Insert a comment
----------------
When you hover on any content in the Wiki page, the **Comment** icon appears on the right side. Click it to make a comment:
.. image:: ../_static/images/organizing-and-exploring-results-in-the-ui/wiki/new_wiki_comment.png
:target: ../_static/images/organizing-and-exploring-results-in-the-ui/wiki/new_wiki_comment.png
:alt: New Wiki comment
:width: 800
Alternatively, select existing text and click the comment button in the context menu that appears:
.. image:: ../_static/images/organizing-and-exploring-results-in-the-ui/wiki/new_wiki_comment_menu.png
:target: ../_static/images/organizing-and-exploring-results-in-the-ui/wiki/new_wiki_comment_menu.png
:alt: New Wiki comment
:width: 600
Share a Wiki page
-----------------
1. Enter the Wiki page you want to share.
2. Click the **Share** button:
.. image:: ../_static/images/organizing-and-exploring-results-in-the-ui/wiki/share_wiki_page.png
:target: ../_static/images/organizing-and-exploring-results-in-the-ui/wiki/share_wiki_page.png
:alt: Share Wiki page
:width: 600
3. In the dialog that appears, click **Copy** to send the link to the clipboard. From there, paste it as needed.
Formatting text, adding links and more
--------------------------------------
When you select existing text in a Wiki page, a contextual menu appears, presenting actions for formatting the selected text:
.. image:: ../_static/images/organizing-and-exploring-results-in-the-ui/wiki/wiki_context_menu.png
:target: ../_static/images/organizing-and-exploring-results-in-the-ui/wiki/wiki_context_menu.png
:alt: Format Wiki text
:width: 450
Formatting headings and adding mentions
---------------------------------------
While in a Wiki page, you can display a menu for formatting a heading or adding a mention of a person or experiment:
.. image:: ../_static/images/organizing-and-exploring-results-in-the-ui/wiki/wiki_commands.png
:target: ../_static/images/organizing-and-exploring-results-in-the-ui/wiki/wiki_commands.png
:alt: Wiki commands
:width: 450
There are two ways to display the menu. Either:
- Type **/**
or
- Hover with the mouse until the **+** icon appears. Then click it.
Collaborative editing
---------------------
You can edit Wiki pages collaboratively (think Google Docs).
In the figure shown here, four users are editing the Wiki page simultaneously.
Their avatars are displayed next to the title page.
Note that each user has one color associated with them.
.. image:: ../_static/images/organizing-and-exploring-results-in-the-ui/wiki/wiki_collaborative_editing.png
:target: ../_static/images/organizing-and-exploring-results-in-the-ui/wiki/wiki_collaborative_editing.png
:alt: Copy URL
In the example, the user who has a green color, has highlighted the word “Project”,
so that it is also highlighted in green.
Another example, is the blue user -- her mouse cursor is next to the word “progress”.
Avatar details
--------------
Hover on an avatar to see user details:
.. image:: ../_static/images/organizing-and-exploring-results-in-the-ui/wiki/avatar_highlight.png
:target: ../_static/images/organizing-and-exploring-results-in-the-ui/wiki/avatar_highlight.png
:alt: Avatar details
:width: 250
Highlighted text
----------------
Hover on the highlighted text to see who highlighted it:
.. image:: ../_static/images/organizing-and-exploring-results-in-the-ui/wiki/editor_details.png
:target: ../_static/images/organizing-and-exploring-results-in-the-ui/wiki/editor_details.png
:alt: Editor details
:width: 250
.. External Links
.. |Charts| raw:: html
Charts
.. |Logs| raw:: html
Logs
.. |Monitoring| raw:: html
Monitoring
.. |Artifacts| raw:: html
Artifacts
.. |Source code| raw:: html
Source code
.. |Parameters| raw:: html
Parameters
.. |Details| raw:: html
Details
.. |example Project| raw:: html
Study this one, for example
.. |experiment details| raw:: html
Here
.. |experiment comparison| raw:: html
here
.. |Notebook checkpoint| raw:: html
sample Notebook checkpoint in Neptune
.. |Notebook comparison| raw:: html
Example comparison