mirror of https://github.com/laurent22/joplin.git
Doc: Fixed typos and grammatical errors in readme files (#4678)
parent
f92679c58a
commit
131a7e7362
|
@ -12,6 +12,6 @@ Conflicts are always annoying to deal with so it is best to avoid them as much a
|
||||||
|
|
||||||
For this, the best way is to synchronise as often as possible, so that you are always working with the latest versions of your notes.
|
For this, the best way is to synchronise as often as possible, so that you are always working with the latest versions of your notes.
|
||||||
|
|
||||||
Joplin attempts to do this by uploading your latest changes within a few seconds. However, downloading changes is done at fixed intervals, every few minutes (as defined in the Config screen) and this is where conflicts may happen. It can also happen if one of your device did not have an internet connection for some times, and then synchronises. A bad internet connection can also hinder synchronisation because it will interrupt the process, which may have to restarted from the beginning to ensure consistency.
|
Joplin attempts to do this by uploading your latest changes within a few seconds. However, downloading changes is done at fixed intervals, every few minutes (as defined in the Config screen) and this is where conflicts may happen. It can also happen if one of your device did not have an internet connection for some times, and then synchronises. A bad internet connection can also hinder synchronisation because it will interrupt the process, which may have to be restarted from the beginning to ensure consistency.
|
||||||
|
|
||||||
So if you have not opened your application in a while, manually sync it and wait for it to complete, that way you are sure that whatever change you make will be on the latest version of the note.
|
So if you have not opened your application in a while, manually sync it and wait for it to complete, that way you are sure that whatever change you make will be on the latest version of the note.
|
||||||
|
|
|
@ -22,7 +22,7 @@ It is possible to get the apps to display or log more information that might hel
|
||||||
|
|
||||||
https://developer.android.com/studio/debug/bug-report
|
https://developer.android.com/studio/debug/bug-report
|
||||||
|
|
||||||
To get a bugreport directly from your device, do the following:
|
To get a bug report directly from your device, do the following:
|
||||||
|
|
||||||
- Be sure you have [Developer Options](https://developer.android.com/studio/debug/dev-options) enabled.
|
- Be sure you have [Developer Options](https://developer.android.com/studio/debug/dev-options) enabled.
|
||||||
- In Developer options, tap Take bug report.
|
- In Developer options, tap Take bug report.
|
||||||
|
|
|
@ -54,7 +54,7 @@ Potential Mentor(s): [CalebJohn](https://github.com/CalebJohn/), [roman_r_m](htt
|
||||||
|
|
||||||
## 4. Real-time collaboration on a note
|
## 4. Real-time collaboration on a note
|
||||||
|
|
||||||
Create a web applications that allows two or more users to collaborate in real time on the same note. Use the Joplin Server API to save and load the note.
|
Create a web application that allows two or more users to collaborate in real time on the same note. Use the Joplin Server API to save and load the note.
|
||||||
|
|
||||||
Expected Outcome: A web application that allows users to collaborate on a note
|
Expected Outcome: A web application that allows users to collaborate on a note
|
||||||
|
|
||||||
|
|
|
@ -39,7 +39,7 @@ Submissions and ideas for projects in any other language should specifically men
|
||||||
|
|
||||||
## Instructions for students
|
## Instructions for students
|
||||||
|
|
||||||
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).
|
Students wishing to participate in Summer of Code must realize, that this is an 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).
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
|
@ -51,7 +51,7 @@ You should start learning the components that you plan on working on before the
|
||||||
|
|
||||||
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 `#gsoc-2021`.
|
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 `#gsoc-2021`.
|
||||||
|
|
||||||
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.
|
You should plan to communicate with your team several times per week, and formally report progress and plans weekly. You are free to choose the format, it can be a sophisticated online document or simple continuous blog on GitHub.
|
||||||
|
|
||||||
Moreover, we require that you come to clear agreement on how to commit, test and build.
|
Moreover, we require that you come to clear agreement on how to commit, test and build.
|
||||||
|
|
||||||
|
@ -68,7 +68,7 @@ First of all, please read the above referenced resources and the [GSoC FAQ](http
|
||||||
3. Take a look at the [list of ideas](https://joplinapp.org/gsoc2021/ideas/). You can have you own idea added by posting it in the [Features category](https://discourse.joplinapp.org/c/features)
|
3. Take a look at the [list of ideas](https://joplinapp.org/gsoc2021/ideas/). You can have you own idea added by posting it in the [Features category](https://discourse.joplinapp.org/c/features)
|
||||||
4. Come up with project that you're interested in and discuss it in [Features category](https://discourse.joplinapp.org/c/features)
|
4. Come up with project that you're interested in and discuss it in [Features category](https://discourse.joplinapp.org/c/features)
|
||||||
5. Write a first draft and get someone to review it
|
5. Write a first draft and get someone to review it
|
||||||
6. Remember: you must link to work such as commits in your proposal. A private place will be created wihtinn the forum for that purposes.
|
6. Remember: you must link to work such as commits in your proposal. A private place will be created within the forum for that purposes.
|
||||||
7. Read [How to write a kickass proposal for GSoC](http://teom.org/blog/kde/how-to-write-a-kick-ass-proposal-for-google-summer-of-code/)
|
7. Read [How to write a kickass proposal for GSoC](http://teom.org/blog/kde/how-to-write-a-kick-ass-proposal-for-google-summer-of-code/)
|
||||||
8. Submit proposal using [Google's web interface](https://summerofcode.withgoogle.com/) ahead of the deadline
|
8. Submit proposal using [Google's web interface](https://summerofcode.withgoogle.com/) ahead of the deadline
|
||||||
9. Submit proof of enrolment well ahead of the deadline
|
9. Submit proof of enrolment well ahead of the deadline
|
||||||
|
@ -150,7 +150,7 @@ Your idea proposal should be a brief description of what the project is, what th
|
||||||
|
|
||||||
Anyone developer can be a mentor if you meet the GSoC eligibility requirements. We will potentially assign a student to you who has never worked on such a large project and will need some help. Make sure you're up for the task. Mentoring takes time, and lots and lots of communication.
|
Anyone developer can be a mentor if you meet the GSoC eligibility requirements. We will potentially assign a student to you who has never worked on such a large project and will need some help. Make sure you're up for the task. Mentoring takes time, and lots and lots of communication.
|
||||||
|
|
||||||
Before subscribing yourself as a mentor, please make sure that the [staff](https://discourse.joplinapp.org/g/staff) is aware of that. Ask them to send the Summer of Code Administrators an email confirming your involvement in the team. This is just a formality to make sure you are a real person we can trust; the administrators cannot know all active developers by their Google account ID. Then drop us an message in the forum.
|
Before subscribing yourself as a mentor, please make sure that the [staff](https://discourse.joplinapp.org/g/staff) is aware of that. Ask them to send the Summer of Code Administrators an email confirming your involvement in the team. This is just a formality to make sure you are a real person we can trust; the administrators cannot know all active developers by their Google account ID. Then drop us a message in the forum.
|
||||||
|
|
||||||
Prospective mentors should read the [mentoring guide](http://www.booki.cc/gsoc-mentoring). Also, Federico Mena-Quintero has written some helpful information based on his experiences in previous years. [His HOWTO](https://people.gnome.org/~federico/docs/summer-of-code-mentoring-howto/index.html) has some useful suggestions for anyone planning to mentor this year.
|
Prospective mentors should read the [mentoring guide](http://www.booki.cc/gsoc-mentoring). Also, Federico Mena-Quintero has written some helpful information based on his experiences in previous years. [His HOWTO](https://people.gnome.org/~federico/docs/summer-of-code-mentoring-howto/index.html) has some useful suggestions for anyone planning to mentor this year.
|
||||||
|
|
||||||
|
|
|
@ -44,5 +44,5 @@ No
|
||||||
## TODO
|
## TODO
|
||||||
|
|
||||||
- [ ] Handle encrypted notes (shared notes will be unencrypted on server)
|
- [ ] Handle encrypted notes (shared notes will be unencrypted on server)
|
||||||
- [ ] Move Joplin note rendererer to separate package and re-use it to render notes in the Nextcloud app
|
- [ ] Move Joplin note renderer to separate package and re-use it to render notes in the Nextcloud app
|
||||||
- [ ] Allow editing note in browser
|
- [ ] Allow editing note in browser
|
||||||
|
|
|
@ -14,7 +14,7 @@ To install a plugin press the Install Plugin button within the `Plugins` page of
|
||||||
|
|
||||||
Within the Joplin Plugins page you have the option to turn individual plugins on or off using the toggle control. After changing the state of a plugin Joplin must be restarted, you may need to check Joplin is not minimising to the system tray/notification area rather than fully closing.
|
Within the Joplin Plugins page you have the option to turn individual plugins on or off using the toggle control. After changing the state of a plugin Joplin must be restarted, you may need to check Joplin is not minimising to the system tray/notification area rather than fully closing.
|
||||||
|
|
||||||
As the plugins integrate into the application itself, each plugin may have its own configuration options within Joplin and may be exectuted in a number of different ways. Ensure that you read the author's documentation fully to understand how each plugin is designed to be configured and used.
|
As the plugins integrate into the application itself, each plugin may have its own configuration options within Joplin and may be executed in a number of different ways. Ensure that you read the author's documentation fully to understand how each plugin is designed to be configured and used.
|
||||||
|
|
||||||
## Uninstalling plugins
|
## Uninstalling plugins
|
||||||
|
|
||||||
|
|
|
@ -14,7 +14,7 @@ However **there is a catch**: in Joplin, notes, even when edited with this Rich
|
||||||
|
|
||||||
- Tables must have a header, because this is a requirement in Markdown. When you create a table, it will let you create it without a header, but under the hood it will add an empty one. And next time you open the note, this empty header will be present.
|
- Tables must have a header, because this is a requirement in Markdown. When you create a table, it will let you create it without a header, but under the hood it will add an empty one. And next time you open the note, this empty header will be present.
|
||||||
|
|
||||||
- All items in a list must be of the same type, so for example all checkboxes, or all bullet points. If you require two different types, you should create two different lists separated by an horizontal rule or similar.
|
- All items in a list must be of the same type, so for example all checkboxes, or all bullet points. If you require two different types, you should create two different lists separated by a horizontal rule or similar.
|
||||||
|
|
||||||
- Special keyboard modes "vim" and "emacs" are not supported.
|
- Special keyboard modes "vim" and "emacs" are not supported.
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue