Skip to content

Commit a78e00e

Browse files
authoredNov 26, 2021
spelling issues fixed. (devonfw#633)
* Update .spellcheck.yml * Update lombok.asciidoc * Update lombok.asciidoc * Update scripts.asciidoc * Update projects.asciidoc * Update advanced-tooling-generic.asciidoc * Update kubectl.asciidoc * Update java.asciidoc * Update docker.asciidoc * Update variables.asciidoc * Update features.asciidoc * Update ide.asciidoc * Update advanced-tooling-windows.asciidoc * Update ide.asciidoc * Update eclipse.asciidoc * Update projects.asciidoc * Update projects.asciidoc * Update projects.asciidoc * Update projects.asciidoc * Update node.asciidoc * Update features.asciidoc * Update features.asciidoc * Update features.asciidoc * Update projects.asciidoc * Update projects.asciidoc * Update projects.asciidoc * Update projects.asciidoc * Update projects.asciidoc * Update projects.asciidoc * Update projects.asciidoc * Update projects.asciidoc * Update projects.asciidoc * Update projects.asciidoc * Update projects.asciidoc * Update projects.asciidoc * Update projects.asciidoc * Update projects.asciidoc * Update projects.asciidoc * Update .spellcheck.yml * Update advanced-tooling-generic.asciidoc * Update eclipse.asciidoc * Update .spellcheck.yml * Update features.asciidoc * Update scripts.asciidoc * Update node.asciidoc * Update advanced-tooling-windows.asciidoc * Update features.asciidoc * Update docker.asciidoc * Update advanced-tooling-windows.asciidoc * Update features.asciidoc * Update java.asciidoc * Update kubectl.asciidoc * Update advanced-tooling-mac.asciidoc * Update cicdgen.asciidoc * Update cobigen.asciidoc * Update configuration.asciidoc * Update docker.asciidoc * Update features.asciidoc * Update gradle.asciidoc * Update ide.asciidoc * Update integration.asciidoc * Update intellij.asciidoc * Update ionic.asciidoc * Update jasypt.asciidoc * Update java.asciidoc * Update jenkins.asciidoc * Update kubectl.asciidoc * Update cicdgen.asciidoc * Update cicdgen.asciidoc * Update cicdgen.asciidoc * Update cobigen.asciidoc * Update docker.asciidoc * Update gradle.asciidoc * Update ide.asciidoc * Update kubectl.asciidoc * Update jenkins.asciidoc * Update java.asciidoc * Update jasypt.asciidoc * Update ionic.asciidoc * Update intellij.asciidoc
1 parent b0733b1 commit a78e00e

20 files changed

+106
-91
lines changed
 

‎.spellcheck.yml

+31-19
Original file line numberDiff line numberDiff line change
@@ -15,36 +15,48 @@ matrix:
1515
- pyspelling.filters.context:
1616
context_visible_first: true
1717
escapes: '^.*[\/\\][^\/\\]+$'
18+
#Ignore for url starting with http or https
19+
- pyspelling.filters.context:
20+
context_visible_first: true
21+
delimiters:
22+
- open: 'https?:\S+?'
23+
close: '\s'
1824
#Ignore content between backticks
1925
- pyspelling.filters.context:
2026
context_visible_first: true
2127
delimiters:
22-
- open: '`+[^`]+'
23-
close: '`+'
24-
#Ignore for upper camel case
25-
- pyspelling.filters.context:
28+
- open: '```'
29+
close: '(\w|\W)+?(?=```)'
30+
#Ignore content between backticks
31+
- pyspelling.filters.context:
2632
context_visible_first: true
2733
delimiters:
28-
- open: '\b[A-Z][a-z0-9]+[A-Z]'
29-
close: '[a-z0-9]*\b'
30-
#Ignore for lower camel case
31-
- pyspelling.filters.context:
34+
- open: '(?<!``)`[^`]+'
35+
close: '`'
36+
#Ignore links
37+
- pyspelling.filters.context:
3238
context_visible_first: true
3339
delimiters:
34-
- open: '\b[a-z]+[A-Z]'
35-
close: '[a-z0-9]*\b'
36-
#Ignore for constants in upper case
37-
- pyspelling.filters.context:
40+
- open: 'link:[^[]+'
41+
close: '\['
42+
#Ignore Image tags
43+
- pyspelling.filters.context:
3844
context_visible_first: true
3945
delimiters:
40-
- open: '\b[A-Z]+'
41-
close: '([_][A-Z]+)*\b'
42-
#Ignore for special cases in CobiGen in upper camel case
46+
- open: 'image:[^[]+'
47+
close: '\['
48+
#Ignore Image tags link part
4349
- pyspelling.filters.context:
4450
context_visible_first: true
4551
delimiters:
46-
- open: '\b__[A-Z][a-z0-9]+[A-Z]'
47-
close: '[a-z0-9.]*__\b'
52+
- open: ',.+?link=[^\]]+'
53+
close: '\]'
54+
#Ignore include tag
55+
- pyspelling.filters.context:
56+
context_visible_first: true
57+
delimiters:
58+
- open: 'include:[^[]+'
59+
close: '\['
4860
- pyspelling.filters.context:
4961
context_visible_first: true
5062
escapes: \\[\\-~]
@@ -59,5 +71,5 @@ matrix:
5971
context_visible_first: true
6072
delimiters:
6173
# Ignore multiline content between [source, *] and blank line
62-
- open: '\[source,.*\]'
63-
close: '^\s*$'
74+
- open: '\[source,.*\]\r?\n\s*----'
75+
close: '\s*----'

‎documentation/advanced-tooling-generic.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ To draw diagrams for your project or for blueprints in devonfw, we recommend the
1111

1212
* https://draw.io/[draw.io] is a powerful generic vector painting program (similar to visio). You can get a free open-source edition for your desktop from https://github.com/jgraph/drawio-desktop/releases[here].
1313
* https://www.objectaid.com/[ObjectAid] is a nice and easy to use eclipse plugin that you can use to quickly create UML diagrams from existing code. While class-diagrams are supported for free, you need to buy a license if you want to use the other diagram types.
14-
* https://plantuml.com/[PlantUML] is a great tool that can render UML diagrams from simple markup that can be easily managed in `git` or other version-control systems together with your code. Its simplicity allows branching and merging unlike other greedy binary UML data-formats.
14+
* https://plantuml.com/[PlantUML] is a great tool that can render UML diagrams from simple markup that can be easily managed in git or other version-control systems together with your code. Its simplicity allows branching and merging unlike other greedy binary UML data-formats.
1515

1616
== Browser Plugins
1717
There are tons of helpful browser plugins out there and it might be a matter of personal taste what you like to have installed. However, as we are heavily using github we want to promote https://github.com/buunguyen/octotree#octotree[octotree].

‎documentation/advanced-tooling-mac.asciidoc

+6-6
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ toc::[]
55

66
== Finder
77

8-
If you want to open a terminal from a folder in `Finder` and automatically get your environment set properly for `devonfw-ide` you will find the perfect solution here.
8+
If you want to open a terminal from a folder in Finder and automatically get your environment set properly for `devonfw-ide` you will find the perfect solution here.
99

1010
image::images/finder-integration.png["devonfw-ide integration in MacOS Finder"]
1111

@@ -20,18 +20,18 @@ So after installing (see below) the integration(s) provided here, you can easily
2020
mvn -v
2121
```
2222

23-
To get this feature for MacOS `Terminal.app` open `Finder` and run the workflow `system/mac/terminal/Open_devonfw-Terminal_here.workflow` (in `${DEVON_IDE_HOME}`). For `iTerm2.app` (that can be installed from `App Store`) do the same with `system/mac/iterm/Open_devonfw-iTerm_here.workflow`.
23+
To get this feature for macOS `Terminal.app` open Finder and run the workflow `system/mac/terminal/Open_devonfw-Terminal_here.workflow` (in `${DEVON_IDE_HOME}`). For iTerm2.app (that can be installed from `App Store`) do the same with `system/mac/iterm/Open_devonfw-iTerm_here.workflow`.
2424

2525
== Keyboard
2626

27-
Keyboard support is not an integration however, some users coming from other platforms may struggle with the way MacOS deals with (external non-apple) keyboards.
27+
Keyboard support is not an integration however, some users coming from other platforms may struggle with the way macOS deals with (external non-apple) keyboards.
2828
So to make it short: if you are happy with your keyboard and shortcuts, you can skip all the following. Otherwise, if you think that pressing keys like `Home`, `End`, etc. should just work as expected or pressing `Alt Gr` should allow you to type the special characters as printed on your German keyboard then here you will find a solution to your problems!
2929
To get all automated you can just run the script `system/mac/keyboard/install-mac-keyboard-support.sh` (in `${DEVON_IDE_HOME}`). If you would like to understand what is going on, you want to customize the keyboard settings to your needs, or you want a keyboard layout other than German ISO, please read on.
3030

3131
=== Keyboard Layouts
3232

33-
Keyboard layouts allow a find-grained mapping of each key on your keyboard to its resulting input character or behaviour. They are MacOS native features and do not need to have software running as a background service to make the keyboard mapping work (see Karabiner section below as an alternative).
34-
They are provided as so called `bundle` (white lego brick icon). Like a MacOS app this is a folder containing a `Contents` folder with a specific sub-folder structure. In the `Resources` subfolder `*.keylayout` files are placed and define the exact mapping for the keyboard. As an example we provide a `Keyboard Layouts` folder containing a `bundle` for a German keyboard mapping.
33+
Keyboard layouts allow a find-grained mapping of each key on your keyboard to its resulting input character or behaviour. They are macOS native features and do not need to have software running as a background service to make the keyboard mapping work (see Karabiner section below as an alternative).
34+
They are provided as so called `bundle` (white lego brick icon). Like a macOS app this is a folder containing a `Contents` folder with a specific sub-folder structure. In the `Resources` subfolder `*.keylayout` files are placed and define the exact mapping for the keyboard. As an example we provide a `Keyboard Layouts` folder containing a `bundle` for a German keyboard mapping.
3535

3636
To install keyboard layouts simply doubleclick the `bundle` or copy it to `~/Library/Keyboard Layouts`. To actually use them go to `System Preferences` and select `Keyboard`. Then, select the tab `Input Sources`. With the `+` button you can add a keyboard layout for your daily usage with your mac. Please note that the keyboard layout shipped with `devonfw-ide` is called `German-ISO` and can be found in the `Others` section at the end of the list. It can be used as an example or template, if you want to create your own layout.
3737

@@ -79,4 +79,4 @@ If you want more dynamics and do not worry about an app that has to run in the b
7979
cd system/mac/keyboard/
8080
cp karabiner/assets/complex_modifications/*.json ~/.config/karabiner/assets/complex_modifications/
8181
```
82-
Now, if you open the `Complex Modifications` in the `Karabiner` app, you can click on the `+ Add rule` button and will see these mappings in the pop up. Select the rules you want to add (e.g. add all) and you are done. Unlike other solutions, you can quickly tweak your keyboard without the need to log out and restart apps, which gives faster trial and error turnarounds. Further, if you want to tweak your own configs, Karabiner comes with a secondary app called `Karabiner-EventViewer` that shows you the names of the keys, modifiers, and apps for the events you are triggering. This is very helpful to get the config right.
82+
Now, if you open the `Complex Modifications` in the Karabiner app, you can click on the `+ Add rule` button and will see these mappings in the pop up. Select the rules you want to add (e.g. add all) and you are done. Unlike other solutions, you can quickly tweak your keyboard without the need to log out and restart apps, which gives faster trial and error turnarounds. Further, if you want to tweak your own configs, Karabiner comes with a secondary app called Karabiner-EventViewer that shows you the names of the keys, modifiers, and apps for the events you are triggering. This is very helpful to get the config right.

‎documentation/advanced-tooling-windows.asciidoc

+7-7
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,10 @@ After you have link:setup.asciidoc[set up] your `devonfw-ide` on a windows machi
1818
you already have windows-explorer integration out-of-the-box.
1919
Just right-click on the folder you would like to open in a terminal and choose from the context menu:
2020

21-
* `Git Bash`
22-
* `Open devonfw CMD shell here`
23-
* `Open devonfw PowerShell here`
24-
* `Open devonfw Cygwin Bash Here` (only if cygwin was installed during setup)
21+
* Git Bash
22+
* Open devonfw cmd shell here
23+
* Open devonfw PowerShell here
24+
* Open devonfw Cygwin Bash here (only if cygwin was installed during setup)
2525

2626
== Tabs everywhere
2727
Many people got used to _tabs_ that have been introduced by all major browsers:
@@ -59,7 +59,7 @@ See link:integration.asciidoc[integration] to make ConEmu work flawless with `de
5959
Do you want complex passwords that differ for each account for security? Do you only want to remember a single password for simplicity? Do you want to have both? Then, you need to install https://keepass.info/[KeePass] right now.
6060

6161
=== Real text editor
62-
A real developer needs a real text editor and not windows build in `notepad`.
62+
A real developer needs a real text editor and not windows built in `notepad`.
6363
The most common choice is https://notepad-plus-plus.org/[Notepad++].
6464

6565
=== Real compression tool
@@ -81,7 +81,7 @@ See also https://www.howtogeek.com/128680/HOW-TO-DELETE-MOVE-OR-RENAME-LOCKED-FI
8181

8282
=== Create symbolic links
8383
Are you are used to symbolic and hard links in Linux? Do you have to work with Windows? Would you also like to have such links in Windows? Why not? Windows https://www.howtogeek.com/howto/16226/complete-guide-to-symbolic-links-symlinks-on-windows-or-linux/[supports real links] (not shortcuts like in other cases).
84-
If you even want to have it integrated in windows explorer you might want to install http://schinagl.priv.at/nt/hardlinkshellext/linkshellextension.html[linkshellextension]. However, you might want to disable `SmartMove` in the http://schinagl.priv.at/nt/hardlinkshellext/hardlinkshellext.html#configuration[configuration] if you face strange performance issues when moving folders.
84+
If you even want to have it integrated in windows explorer you might want to install http://schinagl.priv.at/nt/hardlinkshellext/linkshellextension.html[linkshellextension]. However, you might want to disable SmartMove in the http://schinagl.priv.at/nt/hardlinkshellext/hardlinkshellext.html#configuration[configuration] if you face strange performance issues when moving folders.
8585

8686
=== Linux
8787
Install https://www.cygwin.com/[Cygwin] and get your bash in windows with ssh-agent, awk, sed, tar, and all the tools you love (or hate). Windows 10 has already a Linux as an installable feature included: WSL and from Version 2004 on WSL2, which is a native Linux Kernel running on Windows (an a light weight VM).
@@ -105,7 +105,7 @@ If you like a GUI to easily configure the scrips, that comes with a lot of exten
105105
Do you collaborate sharing your screen, and want to mark a spot on top of what you see? Use http://epic-pen.com/[Epic Pen] to do just that.
106106

107107
=== Analyze graphs
108-
Do you need to visualize complex graph structures? Convert them to https://en.wikipedia.org/wiki/Trivial_Graph_Format[Trivial Graph Format] (.tgf), a run https://www.yworks.com/products/yed[yEd] to get an interactive visualization of your graph.
108+
Do you need to visualize complex graph structures? Convert them to https://en.wikipedia.org/wiki/Trivial_Graph_Format[Trivial Graph Format] `(.tgf)`, a run https://www.yworks.com/products/yed[yEd] to get an interactive visualization of your graph.
109109

110110
=== Up your screen capture game
111111
Capture any part of your screen with a single click, directly upload to dropbox, or run a svn commit all in one go with http://getgreenshot.org/[Greenshot]. Another screen capture tool where you can easily manage and edit your screenshots and also do screen recordings with is https://www.screenpresso.com/download/[Screenpresso].

‎documentation/cicdgen.asciidoc

+4-4
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ The arguments (`devon cicdgen «args»`) are explained by the following table:
1010
[options="header"]
1111
|=======================
1212
|*Argument(s)* |*Meaning*
13-
|`setup` |setup cicdgen (install and verify)
14-
|`update` |update cicdgen (reinstall with @latest version and verify)
13+
|`setup` |setup cicdgen (install and verify)
14+
|`update` |update cicdgen (reinstall with @latest version and verify)
1515
|`java «args»` |generate cicd files for the current devon4java project
16-
|`ng «args»` |generate cicd files for the current devon4ng project
16+
|`ng «args»` |generate cicd files for the current devon4ng project
1717
|`node «args»` |generate cicd files for the current devon4node project
18-
|`«args»` |call cicdgen with the specified arguments
18+
|`«args»` |call cicdgen with the specified arguments
1919
|=======================

‎documentation/cobigen.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,4 @@ The arguments (`devon cobigen «args»`) are explained by the following table:
1515
|`«args»` |run CobiGen with the given arguments (`«args»`)
1616
|=======================
1717

18-
Please read the actual documentation of https://github.com/devonfw/cobigen/blob/master/documentation/howto_Cobigen-CLI-generation.asciidoc#cobigen-command-line-interface-generation[CobiGen CLI] for further details.
18+
Please read the actual documentation of https://github.com/devonfw/cobigen/blob/master/documentation/howto_Cobigen-CLI-generation.asciidoc#cobigen-command-line-interface-generation[CobiGen CLI] for further details.

‎documentation/configuration.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ this will unset the specified variable
3232
tilde is resolved to your personal home directory on any OS including windows.
3333
* `array_variable=(value1 value2 value3)`
3434
+
35-
This will only work properly in `bash` worlds but as no arrays are used in CMD world of `devonfw-ide` it does not hurt on windows.
35+
This will only work properly in bash worlds but as no arrays are used in CMD world of `devonfw-ide` it does not hurt on windows.
3636
* Please never surround values with quotes (`var="value"`)
3737
* This format is similar to Java `*.properties` but does not support advanced features as unicode literals, multi-lined values, etc.
3838

0 commit comments

Comments
 (0)
Please sign in to comment.