Tutorial review #3605
Open
Tutorial review #3605
Conversation
This file contains 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
AlanGriffiths
requested changes
Sep 23, 2024
| @@ -1,7 +1,7 @@ | |||
| # Tutorials | |||
| These pages provide first-time introductions to key Mir aspects | |||
|
|
|||
| - [Learn What Mir Can Do](/tutorial/learn-what-mir-can-do): A showcase of Mir's capabilities | |||
| - [Getting started with Mir](/tutorial/learn-what-mir-can-do): A showcase of Mir's capabilities | |||
There was a problem hiding this comment.
We should probably rename the slug to match
| GNOME and such where you can move windows and maximize or minimize them. Kiosk | ||
| mode on the other hand assumes you want one (or more) applications in | ||
| fullscreen mode all the time. | ||
| Mir allows you to run applications in the *shell mode* or in *kiosk mode*. |
There was a problem hiding this comment.
It comes from the pre-existing text but "shell mode" is a bad term: all the modes are types of shell.
Suggested change
| Mir allows you to run applications in the *shell mode* or in *kiosk mode*. | |
| Mir allows you to run a graphical shell in *desktop mode* or in *kiosk mode*. |
|
|
||
| To run in shell mode, just run: | ||
| Shell mode means that the application is opened in a floating window manager and you can move the window around the screen, maximize or minimize it. | ||
| Kiosk mode means that the application is opened in fullscrean mode. |
There was a problem hiding this comment.
Suggested change
| Kiosk mode means that the application is opened in fullscrean mode. | |
| Kiosk mode means that the application is opened in fullscreen mode. |
|
|
||
| To run in shell mode, just run: | ||
| Shell mode means that the application is opened in a floating window manager and you can move the window around the screen, maximize or minimize it. |
There was a problem hiding this comment.
Suggested change
| Shell mode means that the application is opened in a floating window manager and you can move the window around the screen, maximize or minimize it. | |
| Desktop mode means that application windows are opened are "floating and you can move them around the screen, maximize or minimize them. |
| applications should not be using. For demonstration purposes we will override | ||
| this and allow all supported extensions in some of the following examples by | ||
| passing `--add-wayland-extensions all` when running the example. | ||
| ## Running applications natively |
There was a problem hiding this comment.
Suggested change
| ## Running applications natively | |
| ## Running shells natively |
| The previous section showed how you can run Mir demos under an X11 or Wayland | ||
| session. But Mir compositors can also run "natively" by launching them from a | ||
| virtual terminal or a greeter. | ||
| Mir compositors supports running application natively by launching them from a virtual terminal or a login screen. |
There was a problem hiding this comment.
Suggested change
| Mir compositors supports running application natively by launching them from a virtual terminal or a login screen. | |
| Mir compositors supports running shells natively by launching them from a virtual terminal or a login screen. |
There was a problem hiding this comment.
I'd say that the opposition (native/X11 or Wayland) was useful; otherwise, the meaning of 'natively' may raise questions.
| To switch to a virtual terminal, you can press CTRL+ALT+F\<Number\>. You can then | ||
| log in and run: | ||
|
|
||
| 1. Switch to a virtual terminal by pressing CTRL+ALT+F\<Number\> and log into the virstual environemtn. |
There was a problem hiding this comment.
Suggested change
| 1. Switch to a virtual terminal by pressing CTRL+ALT+F\<Number\> and log into the virstual environemtn. | |
| 1. Switch to a virtual terminal by pressing CTRL+ALT+F\<Number\> and log in. |
|
|
||
| For the purpose of demonstation, we'll use `ubuntu-frame-osk`, but you're free | ||
| to use any Wayland compatible on-screen keyboard. | ||
| **Note**: Due to security reasons, the Wayland extensions are disabled by default. In this tutorial, you will override this setting by |
There was a problem hiding this comment.
Suggested change
| **Note**: Due to security reasons, the Wayland extensions are disabled by default. In this tutorial, you will override this setting by | |
| **Note**: Due to security reasons, some Wayland extensions needed by on-screen keyboards are disabled by default. In this tutorial, you will override this by |
akcano
reviewed
Sep 26, 2024
| ```sh | ||
| gvncviewer localhost | ||
| ``` | ||
| 5. Run your VNC client and connect to `localhost`. You will see the exact view in both Mir compositor and the VNC viewer. |
There was a problem hiding this comment.
One suggestion: consider toning down you wills a bit, there's a whole lot of them here and there (to the point of being noticeable as a syle trick).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
My proposal for some light edits in the first tutorial.
One note on headings - we recommend using sentence capitalization for all headings https://docs.ubuntu.com/styleguide/en
I was also thinking of changing "Learn What Mir Can Do" to "Getting started with Mir". I'm not sure if it's the best choice but it sounds like a basic enough first tutorial that any user should get themselves acquainted with.
I think the tutorial is accessible enough as is so I didn't introduce any significant changes to steps themselves.
Jira: https://warthogs.atlassian.net/browse/DOCPR-852