Skip to content

Commit

Permalink
Update website
Browse files Browse the repository at this point in the history
  • Loading branch information
laurent22 committed Jan 18, 2020
1 parent 8508fe7 commit fe03185
Show file tree
Hide file tree
Showing 4 changed files with 258 additions and 249 deletions.
27 changes: 18 additions & 9 deletions docs/gsoc2020/ideas.html
Original file line number Diff line number Diff line change
Expand Up @@ -345,7 +345,7 @@ <h2>1. Support for multiple profiles<a name="1-support-for-multiple-profiles" hr
<p>Difficulty Level: Moderate</p>
<p>Platforms: Desktop and/or mobile (at the student's choice)</p>
<p>Skills Required: JavaScript; React; React Native (for mobile)</p>
<p>Potential Mentor(s):</p>
<p>Potential Mentor(s): <a href="https://github.com/tessus">tessus</a>, <a href="https://github.com/laurent22/">laurent22</a></p>
<p>More info: <a href="https://github.com/laurent22/joplin/issues/591">GitHub issue</a>, <a href="https://discourse.joplinapp.org/t/can-i-run-a-second-instance-of-joplin/110">Forum Thread</a></p>
<h2>2. Collaboration via Nextcloud<a name="2-collaboration-via-nextcloud" href="#2-collaboration-via-nextcloud" class="heading-anchor">🔗</a></h2>
<p>We need a way to share notes with other users, and to collaborate on notes. This is useful for companies, to collaborate on projects for example, but also for individual users when they want to share their notes with other people.</p>
Expand All @@ -355,23 +355,23 @@ <h2>2. Collaboration via Nextcloud<a name="2-collaboration-via-nextcloud" href="
<p>Difficulty Level: High</p>
<p>Platforms: Desktop and/or mobile (at the student's choice)</p>
<p>Skills Required: JavaScript; React; React Native (for mobile)</p>
<p>Potential Mentor(s):</p>
<p>Potential Mentor(s): <a href="https://github.com/laurent22/">laurent22</a></p>
<p>More info: <a href="https://discourse.joplinapp.org/t/joplin-api-in-nextcloud-prototype/">Forum thread about Joplin Web API for Nextcloud</a></p>
<h2>3. Hierarchical Tags<a name="3-hierarchical-tags" href="#3-hierarchical-tags" class="heading-anchor">🔗</a></h2>
<p>One of the most asked-for feature in Joplin is support for hierarchical tags. This would allow users that heavily rely on tags to organise them into a hierarchy, as is done for the notebooks.</p>
<p>Expected Outcome: The tags can be organised into a hierarchy</p>
<p>Difficulty Level: Moderate</p>
<p>Platforms: Desktop, Mobile and Terminal</p>
<p>Skills Required: JavaScript; React; React Native (for mobile)</p>
<p>Potential Mentor(s):</p>
<p>Potential Mentor(s): <a href="https://github.com/laurent22/">laurent22</a></p>
<p>More info: <a href="https://github.com/laurent22/joplin/issues/375">GitHub issue</a></p>
<h2>4. Sharing on mobile<a name="4-sharing-on-mobile" href="#4-sharing-on-mobile" class="heading-anchor">🔗</a></h2>
<p>The mobile application allows sharing text from any application to Joplin. However it is not currently possible to share images or to share selected text with Joplin. We would like to allow sharing an image or file from any application to Joplin. And to allow selecting some text in an application (in a browser for instance) and share it with Joplin</p>
<p>Expected Outcome: Share images and selected with Joplin</p>
<p>Difficulty Level: Moderate</p>
<p>Platforms: Mobile (iOS and Android)</p>
<p>Skills Required: JavaScript; React; React Native</p>
<p>Potential Mentor(s):</p>
<p>Potential Mentor(s): <a href="https://github.com/laurent22/">laurent22</a></p>
<p>More info: <a href="https://github.com/laurent22/joplin/issues/876">Mobile - Add share menu #876</a></p>
<h2>5. Web client for Nextcloud<a name="5-web-client-for-nextcloud" href="#5-web-client-for-nextcloud" class="heading-anchor">🔗</a></h2>
<p>There is the community's wish to have the notes integrated Nextcloud, so that Notes can be sought by Nextcloud itself. Although this idea focuses on Nextcloud it shall allow to extend it to other collaboration applications going beyond the current scope of <a href="https://joplinapp.org/#synchronisation">Synchronisation</a>. There is already the <a href="https://github.com/foxmask/joplin-web">web application</a> what may used as a starting point, but it is also fine to start from scratch.</p>
Expand All @@ -385,25 +385,28 @@ <h2>5. Web client for Nextcloud<a name="5-web-client-for-nextcloud" href="#5-web
<p>Expected Outcome: Viewing and editing notes and notebooks from a Nextcloud-based web client</p>
<p>Difficulty Level: High</p>
<p>Skills Required: PHP (for the Nextcloud app). For the front-end it can be plain HTML (no JS), or React.</p>
<p>Potential Mentor(s):</p>
<p>Potential Mentor(s): <a href="https://github.com/laurent22/">laurent22</a></p>
<p>More info: <a href="https://github.com/laurent22/joplin/issues/228">GitHub: Nextcloud notes integration (Web client)</a></p>
<h2>5. OCR support<a name="5-ocr-support" href="#5-ocr-support" class="heading-anchor">🔗</a></h2>
<p>It is possible to add support for OCR content in Joplin via the <a href="http://tesseract.projectnaptha.com/">Tesseract library</a>. A first step would be to assess the feasibility of this project by integrating the lib in the desktop app and trying to OCR an image. OCR support should be implemented as a service of the desktop app. It would extract the text from the images, and append the content as plain text to the notes.</p>
<p>Expected Outcome: A service on the desktop app that extract text from images and attach it to the note.</p>
<p>Difficulty Level: High</p>
<p>Skills Required: JavaScript</p>
<p>Potential Mentor(s):</p>
<p>Potential Mentor(s): <a href="https://github.com/laurent22/">laurent22</a></p>
<h2>6. Password-protected notes<a name="6-password-protected-notes" href="#6-password-protected-notes" class="heading-anchor">🔗</a></h2>
<p>We would like to add an option to allow encrypting a note or a notebook with a password. When opening the note, the password must be provided to reveal the content.</p>
<p>Expected Outcome: The user select a note and has the option to encrypt it.</p>
<p>Difficulty Level: Medium</p>
<p>Skills Required: JavaScript; React</p>
<p>Potential Mentor(s):</p>
<p>Potential Mentor(s): <a href="https://github.com/PackElend">PackElend</a>, <a href="https://github.com/laurent22/">laurent22</a></p>
<h2>7. Search<a name="7-search" href="#7-search" class="heading-anchor">🔗</a></h2>
<p>The current search engine is built on top of SQLite FTS. An index of the notes is built and this is what is used by FTS when searching.</p>
<p>While it works relatively well, there is still room for improvement. In particular we would like to implement the following:</p>
<ul>
<li>
<p>Allow boolean searches - search for &quot;A and B&quot;, or &quot;A or B&quot;, etc.</p>
</li>
<li>
<p>Remove the need for wildcard queries - for example instead of typing &quot;search*&quot;, it will be possible to simply type &quot;search&quot; and results that contain &quot;search&quot; or &quot;searching&quot; will be included. Those that contain the exact match will come first.</p>
</li>
<li>
Expand All @@ -419,15 +422,21 @@ <h2>7. Search<a name="7-search" href="#7-search" class="heading-anchor">🔗</a>
<p>Expected Outcome: To be defined with the student. Depending on what features they would like to implement.</p>
<p>Difficulty Level: Medium</p>
<p>Skills Required: JavaScript</p>
<p>Potential Mentor(s):</p>
<p>Potential Mentor(s): <a href="https://github.com/laurent22/">laurent22</a></p>
<p>More info: <a href="https://github.com/laurent22/joplin/issues/1877">Search engine improvements</a></p>
<h2>8. WYSIWYG Editor<a name="8-wysiwyg-editor" href="#8-wysiwyg-editor" class="heading-anchor">🔗</a></h2>
<p>The current editor shows the Markdown text on the left side and the rendered HTML on the right side (a split view). We would like to add another editor option, which would be a WYSIWYG editor, where the user can directly edit formatted text. This would not replace the split view but rather be an alternative editor and the user can choose either split view or WYSIWYG.</p>
<p>Expected Outcome: To add a WYSIWYG editor to the desktop app.</p>
<p>Difficulty Level: High</p>
<p>Skills Required: JavaScript; React</p>
<p>Potential Mentor(s):</p>
<p>Potential Mentor(s): <a href="https://github.com/PackElend">PackElend</a>, <a href="https://github.com/laurent22/">laurent22</a></p>
<p>More info: <a href="https://discourse.joplinapp.org/t/wysiwyg-editor-in-joplin/2253">WYSIWYG thread on the forum</a></p>
<h1>9. Custom keyboard shortcuts<a name="9-custom-keyboard-shortcuts" href="#9-custom-keyboard-shortcuts" class="heading-anchor">🔗</a></h1>
<p>The CLI application allows setting custom keyboard shortcuts, however this feature is currently missing from the desktop application. We would like to let the user set shortcuts for the menu items in particular, but also potentially any other Joplin action. There should be a shortcut editor in the Config panel to do this.</p>
<p>Expected Outcome: To add support for custom shortcuts and allow editing them in the config screen</p>
<p>Difficulty Level: Easy</p>
<p>Skills Required: JavaScript; React</p>
<p>Potential Mentor(s): <a href="https://github.com/tessus">tessus</a>, <a href="https://github.com/laurent22/">laurent22</a></p>

<div class="bottom-links">
<a href="https://github.com/laurent22/joplin/blob/master/readme/gsoc2020/ideas.md">
Expand Down
4 changes: 2 additions & 2 deletions docs/gsoc2020/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -357,11 +357,11 @@ <h2>Programming Language<a name="programming-language" href="#programming-langua
<p>Submissions and ideas for projects in any other language should specifically mention the choice.</p>
<h2>Instructions for students<a name="instructions-for-students" href="#instructions-for-students" class="heading-anchor">🔗</a></h2>
<p>Students wishing to participate in Summer of Code must realize, that this is a important professional opportunity. You will be required to produce applicable and readable code for Joplin in 3 months. Your mentors, will dedicate a portion of their time to mentoring you. Therefore, we seek candidates who are committed to helping Joplin and its community long-term and are willing to both do quality work, and be proactive in communicating with your mentor(s).</p>
<p>You don't have to be a proven developer -- in fact, this whole program is meant to facilitate joining Joplin and other Open Source communities. However, experience in coding and/or experience with the above mentioned programming languages and the applications is welcome.</p>
<p>You don't have to be a proven developer - in fact, this whole program is meant to facilitate joining Joplin and other Open Source communities. However, experience in coding and/or experience with the above mentioned programming languages and the applications is welcome.</p>
<p>In general it can be said, that question shall be asked early and clearly, given everyone the possibility to understand why you want to have this question answered and how it helps to achieve the project's goal.</p>
<p>Before you can be accepted as a student we expect you to fix some bugs or implement some small feature and link that work on your proposal. You may browse the <a href="https://github.com/laurent22/joplin/issues">GitHub Issues</a> to find some simple tasks. See the <a href="https://github.com/laurent22/joplin/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22">good first issues</a> which are a good way to make yourself familiar with the code base.</p>
<p>You should start learning the components that you plan on working on before the start date. Support can be found in the forum and on our dedicated discourse channel.</p>
<p>Do not worry, the timeline from Google reserves a lot of time for bonding periods but use that time wisely. Good communication is key. To allow us to respond quickly tag your questions with #GSoC and #2020.</p>
<p>Do not worry, the timeline from Google reserves a lot of time for bonding periods so use that time wisely. Good communication is key. To allow us to respond quickly tag your questions with <code>#gsoc-2020</code>.</p>
<p>You should plan to communicate with your team several times per week, and formally report progress and plans weekly. You are free to chose the format, it can be an sophisticated online document or simple continuous blog on GitHub.</p>
<p>Moreover, we require that you come to clear agreement on how to commit, test and build.</p>
<p>Students who neglect active communication will be failed!</p>
Expand Down
Loading

0 comments on commit fe03185

Please sign in to comment.