#42 format
Merged 2 years ago by pbokoc. Opened 2 years ago by jibecfed.
fedora-docs/ jibecfed/documentation-contributors-guide format  into  master

@@ -10,20 +10,20 @@ 

  == Editing online in Pagure

  

  . Click the "Edit this Page" link to load the documentation source.

- You will be taken to the appropriate content repository in Pagure.

+   You will be taken to the appropriate content repository in Pagure.

  

  . Above the source listing on the right side, click "Fork and Edit".

- (If you have already forked the repository, this button will be labeled "Edit in your fork" and you can skip to the next step.)

+   (If you have already forked the repository, this button will be labeled "Edit in your fork" and you can skip to the next step.)

  

  .. If you are not already logged in to Pagure, you will be asked for your credentials.

  

  .. Wait for the operation to finish.

- You may need to refresh the page as it does not always update automatically when the process is done.

+    You may need to refresh the page as it does not always update automatically when the process is done.

  

  . Once the file is loaded in your fork, make any changes necessary to the content, commit them to your fork, and prepare a pull request (PR).

  

  .. Each PR should be submitted from its own branch in your repository.

- Under the "Branch" heading of the commit interface, select "New branch" and give the branch a short, unique name.

+    Under the "Branch" heading of the commit interface, select "New branch" and give the branch a short, unique name.

  

  .. Fill out the commit message form.

  
@@ -39,30 +39,30 @@ 

  .Git commit tips

  ====

  * When naming your branch, use only ASCII letters, digits, hyphens (`-`) and underscores (`_`).

- The name pass:q[_may_] contain, but not start or end with, single periods (`.`).

+   The name pass:q[_may_] contain, but not start or end with, single periods (`.`).

  Spaces, double periods (`..`), and most other punctuation are not permitted.

  

  * The commit title is how your edit will be identified in the repository log for the page.

- The suggested title, "Update [filename]``pathname``", is sufficient for small edits.

- For some advice on writing good commit messages,

+   The suggested title, "Update [filename]``pathname``", is sufficient for small edits.

+   For some advice on writing good commit messages,

  see link:++https://commit.style++[commit.style] by Tim Pope (author of [application]`vim`).

  

  * Use the "Commit Description" field to provide additional detail if necessary, but keep it short.

- You will have the opportunity to explain or discuss your changes when you submit your PR.

+   You will have the opportunity to explain or discuss your changes when you submit your PR.

  ====

  

  == Offline editing

  

  . Click the "Edit this Page" link to load the documentation source.

- You will be taken to the appropriate content repository in Pagure.

- Once you have located the correct repository, make a fork if you do not have it forked already:

+   You will be taken to the appropriate content repository in Pagure.

+   Once you have located the correct repository, make a fork if you do not have it forked already:

  

  .. In the top right corner, click Fork.

  

  .. If you are not already logged in to Pagure, you will be asked for your credentials.

  

  .. Wait for the operation to finish.

- You may need to refresh the page as it does not always update automatically when the process is done.

+   You may need to refresh the page as it does not always update automatically when the process is done.

  

  .. Clone your fork.

  
@@ -71,7 +71,7 @@ 

  . If you added any new files, then ensure they are included in a reasonable spot in the repository's [filename]`nav.adoc` configuration file

  

  . Build locally and make sure everything looks the way you expect.

- See xref:local-preview.adoc[Building a local preview] for instructions.

+   See xref:local-preview.adoc[Building a local preview] for instructions.

  

  . Once you finish, commit your changes and push them to your fork.

  

one more minor change to reduce localization script log output

Pull-Request has been merged by pbokoc

2 years ago