markt-asf commented on PR #9: URL: https://github.com/apache/tomcat-connectors/pull/9#issuecomment-2270572433
> Folks, are you ok with accepting PRs for doc improvements this way? Yes. > The [page discussing doc contributions](https://tomcat.apache.org/connectors-doc/miscellaneous/doccontrib.html) proposes many more steps (including "building" the docs), but is it really necessary for us just to propose simple textual changes like in this PR? No. That page could probably do with some clarifications. I think the instructions on how to build the docs will be useful for some contributors but we shouldn't be giving the impression they are required. > 1. I do appreciate that this page I'm proposing correcting is perhaps the least important (as it's an old proposal that has barely changed in over a dozen years), but it IS listed on the left nav bar of [the connector docs pages](https://tomcat.apache.org/connectors-doc/). So people coming to the docs will see it, and could appreciate the page's typo and grammar errors being addressed. Ack. I think we need to keep it in some form but make clear it is historical. > 2. Indeed, I've wanted to propose those for other pages in the docs, and I've always been discouraged given the build process, when I'd just be proposing wording changes. We need to fix that. > I found this section of the connector repo with the docs, and I'm hoping you may be open to at least considering proposed doc changes this way. Absolutely. The more the merrier. > 3. Finally, I appreciate that some github repo maintainers have their preferences, perhaps not even caring for PRs "out of the blue". I didn't find an option here in this github repo to open an issue. We still use BugZilla for issue tracking. Migration to GitHub issues has been discussed but there are no form plans to do so at the moment. > And I'm hoping you wouldn't require we open a discussion thread in one of the lists, just to make such typo proposals. But I'm interested to hear if you'll prefer something other than what I've done here. This is fine. We try to avoid fixed processed unless absolutely necessary. For everything else we try to keep process to a minimum and let folks use their judgement as to what is the right approach based on the scale of the change, backwards compatibility, risk etc. > I really am just trying to help. Which is very much appreciated. I'll merge this as soon as I finish typing this. -- 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: dev-unsubscr...@tomcat.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org For additional commands, e-mail: dev-h...@tomcat.apache.org
