Welcome! answers inline:
On Mon, Apr 26, 2021, at 11:26, Karen Lease wrote: > Hello Camel developers, > > I'm Karen Lease & I'm interested in contributing to your project. Many > years ago I was a committer on FOP but stopped due to my professional > workload. For my job I had developed a small "pipeline" project to chain > together various processes such as XSLT & FOP specified in an XML > configuration, so the Camel philosophy is familiar to me. > > As suggested, I started by browsing the documentation (which is very > nicely presented) and I found a small issue on the User Stories page > which I propose to fix. > > On the rendered page at > https://camel.apache.org/manual/latest/user-stories.html, the cells are > in the wrong column after the "Red Hat integration" link. This is due to > a missing vertical bar after the RedHat link in the file > https://github.com/apache/camel/blob/main/docs/user-manual/modules/ROOT/pages/user-stories.adoc. > > As I'm a newbie to the project and also to Github, I'd like to confirm > how this should be fixed. If I click on the "Edit this page" link, it > says I have to fork the repository to propose changes. So I assume that > means I should: > > 1. Fork the camel repository > > 2. Commit the change in my fork > > 3. Submit a pull request to integrate the fork into the main repository This is the general process for contributing used for multi file contribution more complicated contribution. > Is that correct? The reason I'm asking is that the description on the > page > https://camel.apache.org/manual/latest/faq/how-do-i-edit-the-website.html > doesn't say anything about the "forking" process and implies that after > clicking "Edit this page", you only need to edit the file, preview the > changes and that will automatically create the pull request. Making a > fork just to add one character seems like overkill but if that's the > process, I'm fine with it. In that case, I could also make some minor > changes to grammar which I noticed while browsing other docs. For smaller fixes is totally fine to just use the "Edit this page button". > I also noticed that the page "how-do-i-edit-the-website.html" has some > inconsistencies in the description of how to edit the documentation in a > local repository. For example, it says that the site.yml file should be > updated to reference your local repository, but there isn't such a file. > When I looked at the https://github.com/apache/camel-website repository, > I found it also contained a user-stores.md page > (https://github.com/apache/camel-website/blob/main/content/community/user-stories.md) > > but with different content than the adoc file. > > Since the actual website matches the adoc file, I assume the md file in > camel-website is obsolete. There are some other files which have both > .adoc & .md files. Would it make sense to delete the .md files from the > camel-website if those are obsolete? Not sure here cc: zo...@regvart.com > Thanks in advance for any suggestions, > > Karen > > > >
