Changed format to backticks for code and bold for tools and UI elements #33
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 1. Qt5 (or one of its packages, e.g. qt5xbase) is missing | ||
| It might be becuase your Debian is too old to have a recent enough version in its official repositories. It is | ||
| suggested to use the same packages that are used while building (make sure to adapt the Qt version and your | ||
| 1. `Qt5` (or one of its packages, e.g. `qt5xbase`) is missing. |
Contributor
There was a problem hiding this comment.
Qt5 can remain as it is.
| suggested to use the same packages that are used while building (make sure to adapt the Qt version and your | ||
| 1. `Qt5` (or one of its packages, e.g. `qt5xbase`) is missing. | ||
| It might be because your Debian is too old to have a recent enough version in its official repositories. It is | ||
| suggested to use the same packages that are used while building (make sure to adapt the `Qt` version and your |
| To ensure the tool functionality, make sure you add the `OPENMS_DATA_PATH` variable to your environment as follow | ||
| `export OPENMS_DATA_PATH=/usr/share/OpenMS` | ||
| 4. Thirdparty installation of Qt5 in 1 | ||
| 4. Thirdparty installation of `Qt5` in 1 |
| Java is usually present in the `PATH` of the terminal. Adavanced users can set this path in the `Info.plist` of/inside | ||
| the `TOPPAS.app`. | ||
| 2. Bug with running Java based thirdparty tools like MSGFPlusAdapter and LuciphorAdapter from within **TOPPAS.app** | ||
| If you face issues while running Java based thirdparty tools from within TOPPAS.app, run the TOPPAS.app from within |
Contributor
There was a problem hiding this comment.
can you add a newline b/t 56 and 57 line number.
tapaswenipathak
approved these changes
May 24, 2022
tapaswenipathak
added a commit
that referenced
this pull request
May 29, 2022
* Changed format to backticks for code and bold for tools and UI elements (#33) * made changes to several files * formatted text with backticks and bold * add internal link within the page to quality-control.md * removed backticks from Qt and related software * Fixes: review comments by @greengypsy (#34) * Fixes: review comments by @greengypsy * review fixes and add a few links to tutorials * Added keyboard syntax plus other minor changes (#35) * added keyboard syntax plus other minor changes such as adding full stops to sentences * added spaces between symbols as discussed Co-authored-by: Tapasweni Pathak <tapaswenipathak@gmail.com> * Use correct admonitions (#36) * added one note to installation on gnu linux md file * added one note to installation on gnu linux md file * added admonitions to noted text * changed admonition types as discussed in review * Add downloads page * Add introduction of a few concepts (#39) * Add introduction of a few concepts Fixes #14. * Fixes: review comments by @greengypsy * Fixes: review comments by @jpfeuffer * Update docs/introduction.md Co-authored-by: Julianus Pfeuffer <pfeuffer@informatik.uni-tuebingen.de> * Update docs/introduction.md Co-authored-by: Julianus Pfeuffer <pfeuffer@informatik.uni-tuebingen.de> * Update docs/introduction.md Co-authored-by: Julianus Pfeuffer <pfeuffer@informatik.uni-tuebingen.de> * Update docs/introduction.md Co-authored-by: Julianus Pfeuffer <pfeuffer@informatik.uni-tuebingen.de> * delete: redundant note Co-authored-by: Julianus Pfeuffer <pfeuffer@informatik.uni-tuebingen.de> * More docs (#40) * created About.rst * linked Developer FAQ to external website * linked Developer FAQ to external website * linked Developer FAQ to external website * fix links in About.rst * Update About.rst * Update About.rst * Update About.rst * changed About.rst to about.rst * Rename About.rst to about.rst * added known-issues.rst * fix bullet point in known-rst * add code to known-issues.rst * add code to known-issues.rst * fix code to known-issues.rst * added VS output to known-issues.rst * added VS output to known-issues.rst * added VS output to known-issues.rst * added VS output to known-issues.rst * added VS output to known-issues.rst * added more text to known-issues.rst * tried adding console code to known-issues.rst * completed copying content for known-issues.rst * added topp-faq.rst and docutils.conf * changed contents title in topp-faq.rst * inline cpp class in topp-faq.rst * FileInfo is not a cpp class its a tool * adding console code * adding console code * adding console code * add monospace text to topp-faq.rst * fixed code blocks * created about contact for-developers for-users reporting-bugs-issues rst files * created developer-faq.rst * developer-faq changes * developer-faq changes * developer-faq changes * developer-faq changes * testing * developer-faq * developer-faq * developer-faq * developer-faq * developer-faq * developer-faq * developer-faq * minor change * renamed folder to lower case * made small changes to files and created 3 empty .md files * added pyopenmswrapping classes link * removed about.rst and added about.md * added contact.md * created for-developers.md * modified for-developers.md * created building-openms.md * just checking links in contact.md * added contributor quickstart guide, users quick start guide and reporting bugs and issues md files * added linkstobs to flag dead links * fixed some links and deleted for-developers.md * modified about.md, deleted building-openms.md, created build-openms-from-source.md, developer-faq.md * modified quickstart guide contributors, developer faq, reporting bugs, and user quick start guide * added coding convents and write and label github issues md files, edited several others * added Notes to developer-faq.md plus other minor edits * added contributor-faq * added coding-convetions.md * added contributor-faq.md * updated pull request checklist md file * updated write-and-label-github-issues * made changes suggested in the review * updated folder structure as suggested in review * added installations folder with build-openms-from-source.md as discussed * created openms-git-workflow.md and click-fork.png under new directories additional-resources and images * minor changes * fix spacing issues * fix alignment issues * Add a few more from #4 * Fixes: review comments by @jpfeuffer Co-authored-by: greengypsy <ckumar073@gmail.com> Co-authored-by: greengypsy <31978630+greengypsy@users.noreply.github.com> * Add lexers to project (#47) * modified conf.py and requirements.txt to include pygments code * added lexers to code in several files * Add conda installation instructions and a few reorderings (#38) Fixes #15. Fixes #16. * Add wiki and a few more docs (#48) * Add: Adding your own tool to the TOPP suite * Add: writing and shipping external code using openms * Add: Compiling with self built compilers and non default standard libraries * Add: wiki: Build your own OpenMS KNIME package * Add: wiki: OpenMS-2.0-kernel-whitepaper * Add: wiki: Developer Guidelines for adding new dependent libraries * Add: Glossary 🎉 (#49) * Production ready[1]: Touchup and cleanup (#51) * Add: build-openms-from-source in sidebar menu * let's make everything work on staging-openms, too * reduce: sidebar menu under introduction * reduce: sidebar menu list * Add: a few sections in sidebar menu of topp tut * Add tabs for installations using installers Fixes #17. * minor fixes + cleanup * add Discord invite link * Update docs/tutorials/TOPP/quality-control.md Co-authored-by: Julianus Pfeuffer <pfeuffer@informatik.uni-tuebingen.de> Co-authored-by: Julianus Pfeuffer <pfeuffer@informatik.uni-tuebingen.de> * Spell out RC * Production ready[2]: Touchup and cleanup (#58) * fix: follow Sentence case for h2 or less * fix: glossary terms in introduction page * add tabs: ux * fix: follow Title Case and reword * add: description plus file name * fix: dropdown menu sidebar toppas tut * add: +reword .github templates * add: more glossary * fix: include faq * add: glossary more Co-authored-by: greengypsy <31978630+greengypsy@users.noreply.github.com> Co-authored-by: Julianus Pfeuffer <pfeuffer@informatik.uni-tuebingen.de> Co-authored-by: greengypsy <ckumar073@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Describe the change
As discussed, I've made sure backticks have been used for code and bold for tools and UI elements. Multiple files are affected.
Closes #31
PR checklist
CHANGELOG.mdis updated.