Bukama commented on code in PR #687:
URL: https://github.com/apache/maven-site/pull/687#discussion_r1957262048


##########
content/apt/guides/development/guide-maven-development.apt:
##########
@@ -100,6 +100,12 @@ Developing Maven
 
  * Make sure that you follow our code style, see {{{Further_Links}Further 
Links}}.
 
+ ** Small amendments of the documentation
+
+ If you want to submit small site amendments, for example correct a spelling 
mistake, you don't have to do the full setup described before.
+ You can simply hit the "Edit" button after the page's title the breadcrumb 
section on the top of the page.

Review Comment:
   While it was easy in the markdown file, I spent an hour trying to get in 
done in the apt file without getting it done. It looks like apt only supports 
stand alone images but not inline in text.
   
   ```
       You can simply hit the "Edit" [/images/accessories-text-editor.png] Edit 
button after the page's title in the breadcrumb section on the top of the page.
   
   [/images/accessories-text-editor.png] Edit
   ```
   
   The second gets correctly displayed as an image, the first is just text. I 
also tried to link to the image, but that's results (as expected) in a link. In 
whole site repository we also don't have any apt file with inline image (we had 
xdoc but no apt).
   
   So I decided to leave out the icon for the moment to keep the text change 
isolated, but will add it, when I convert the page to markdown in a separate PR.
   
   (However I fixed the subsection heading of the apt file)



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscr...@maven.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org

Reply via email to