mirror of
https://github.com/QubesOS/qubes-doc.git
synced 2025-02-18 13:54:11 -05:00
Update image linking syntax; use syntax on same page
This commit is contained in:
parent
d33cd36170
commit
c1f1ee902c
@ -67,42 +67,42 @@ Ok, let's start.
|
||||
Every documentation page has an "Edit this page" button.
|
||||
It may be on the side (in the desktop layout):
|
||||
|
||||

|
||||
[](/attachment/wiki/doc-edit/03-button2.png)
|
||||
|
||||
Or at the bottom (in the mobile layout):
|
||||
|
||||

|
||||
[](/attachment/wiki/doc-edit/02-button1.png)
|
||||
|
||||
When you click on it, you'll be prompted for your GitHub username and password (if you aren't already logged in).
|
||||
You can also create an account from here.
|
||||
|
||||

|
||||
[](/attachment/wiki/doc-edit/04-sign-in.png)
|
||||
|
||||
If this is your first contribution to the documentation, you need to "fork" the repository (make your own copy). It's easy --- just click the big green button on the next page.
|
||||
This step is only needed the first time you make a contribution.
|
||||
|
||||

|
||||
[](/attachment/wiki/doc-edit/05-fork.png)
|
||||
|
||||
Now you can make your modifications.
|
||||
You can also preview the changes to see how they'll be formatted by clicking the "Preview changes" tab.
|
||||
If you're making formatting changes, please [render the site locally] to verify that everything looks correct before submitting any changes.
|
||||
|
||||

|
||||
[](/attachment/wiki/doc-edit/06-edit.png)
|
||||
|
||||
Once you're finished, describe your changes at the bottom and click "Propose file change".
|
||||
|
||||

|
||||
[](/attachment/wiki/doc-edit/07-commit-msg.png)
|
||||
|
||||
After that, you'll see exactly what modifications you've made.
|
||||
At this stage, those changes are still in your own copy of the documentation ("fork").
|
||||
If everything looks good, send those changes to us by pressing the "Create pull request" button.
|
||||
|
||||

|
||||
[](/attachment/wiki/doc-edit/08-review-changes.png)
|
||||
|
||||
You will be able to adjust the pull request message and title there.
|
||||
In most cases, the defaults are ok, so you can just confirm by pressing the "Create pull request" button again.
|
||||
|
||||

|
||||
[](/attachment/wiki/doc-edit/09-create-pull-request.png)
|
||||
|
||||
That's all!
|
||||
We will review your changes.
|
||||
@ -111,15 +111,16 @@ Otherwise, we may have some questions for you, which we'll post in a comment on
|
||||
(GitHub will automatically notify you if we do.)
|
||||
If, for some reason, we can't accept your pull request, we'll post a comment explaining why we can't.
|
||||
|
||||

|
||||
[](/attachment/wiki/doc-edit/10-done.png)
|
||||
|
||||
|
||||
### How to add images
|
||||
|
||||
To add an image to a page, use the following syntax in the main document:
|
||||
To add an image to a page, use the following syntax in the main document.
|
||||
This will make the image a hyperlink to the image file, allowing the reader to click on the image in order to view the image by itself.
|
||||
|
||||
```
|
||||

|
||||
[](/attachment/wiki/page-title/image-filename.png)
|
||||
```
|
||||
|
||||
Then, submit your image(s) in a separate pull request to the [qubes-attachment] repository using the same path and filename.
|
||||
|
Loading…
x
Reference in New Issue
Block a user