djencks commented on pull request #6485:
URL: https://github.com/apache/camel/pull/6485#issuecomment-984125710


   There are already two pages explaining how to work on the website.
   
   Currently the faq page manual/faq/how-do-i-edit-the-website.html explains in 
perhaps appropriate detail how to use the “edit this page” button.  I added 
some notes on when not to try to use it.  It used to have a really incomplete 
description of how to do a local build: I removed that and pointed to the other 
page,
   
   manual/improving-the-documentation.html which now has a note mentioning when 
using the “edit this page” is appropriate, and more complete instructions on 
more complex edits.
   
   I did’t want to change things too much :-)
   
   Without the constraints of history, what I’d like is to have all the 
instructions on the manual/improving-the-documentation.html page in  top-level 
sections, and a little bit of explanation with two links but no instructions on 
the faq page.  Shall I make that change and we can discuss the result?
   
   > On Nov 30, 2021, at 10:11 PM, Claus Ibsen ***@***.***> wrote:
   > 
   > 
   > I think we need to separate this into two pages / sections. One for a 
beginner that just want to help fixing a typo, adding a paragraph to an 
existing page, etc. vs Camel comitters that maintain several sub projects and 
needs to better understand how these are linked together, and how it works with 
antora etc.
   > 
   > The docs may be too overwhelming for the beginner that just want an easy 
way to contribute - eg browse the docs, click the "edit this page" in the 
bottom, edit/preview on github, and click submit as PR. That we absolutely need 
to tell so we can have new users easily contribute.
   > 
   > —
   > You are receiving this because you modified the open/close state.
   > Reply to this email directly, view it on GitHub 
<https://github.com/apache/camel/pull/6485#issuecomment-983321551>, or 
unsubscribe 
<https://github.com/notifications/unsubscribe-auth/AAELDXWZZYRIW56CXQLD3WDUOW37NANCNFSM5I4TDTDA>.
   > 
   
   


-- 
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: commits-unsubscr...@camel.apache.org

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


Reply via email to