You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "elharo (via GitHub)" <gi...@apache.org> on 2026/08/05 13:24:03 UTC

[PR] docs: rewrite creating-a-repository-system-session.md to STE rules [maven-resolver]

elharo opened a new pull request, #2034:
URL: https://github.com/apache/maven-resolver/pull/2034

   Rewrite the page to ASD-STE100 Simplified Technical English, following the pattern of prior doc rewrites (#2022, #2024, #2026).
   
   Key changes:
   - Separated descriptive and procedural passages; procedural text uses the imperative mood.
   - Removed banned modals (\"should\") and non-approved verb forms (\"-ing\", \"has to be\").
   - Split long sentences; kept each descriptive sentence at or under 25 words and each procedural sentence at or under 20 words.
   - Removed filler words and simplified expressions.
   - Preserved the code example and all links verbatim.


-- 
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-unsubscribe@maven.apache.org

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


Re: [PR] docs: rewrite creating-a-repository-system-session.md to STE rules [maven-resolver]

Posted by "cstamas (via GitHub)" <gi...@apache.org>.
cstamas merged PR #2034:
URL: https://github.com/apache/maven-resolver/pull/2034


-- 
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-unsubscribe@maven.apache.org

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


Re: [PR] docs: rewrite creating-a-repository-system-session.md to STE rules [maven-resolver]

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #2034:
URL: https://github.com/apache/maven-resolver/pull/2034#issuecomment-5197579663

   @cstamas Please assign appropriate label to PR according to the type of change.


-- 
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-unsubscribe@maven.apache.org

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


Re: [PR] docs: rewrite creating-a-repository-system-session.md to STE rules [maven-resolver]

Posted by "elharo (via GitHub)" <gi...@apache.org>.
elharo commented on code in PR #2034:
URL: https://github.com/apache/maven-resolver/pull/2034#discussion_r3721317326


##########
src/site/markdown/creating-a-repository-system-session.md:
##########
@@ -44,18 +37,10 @@ import org.eclipse.aether.supplier.RepositorySystemSupplier;
     }
 ```
 
-As you see, the only setting that must be specified is the local
-repository, other settings are initialized with default values. Please
-have a look at the API docs for `RepositorySystemSession.SessionBuilder` to
-learn about all the other things you can configure for a session.
-
-In case of Maven plugin, or when code runs embedded in Maven, the session
-is already created for you, but you can still "derive" using copy constructor
-of `DefaultRepositorySystemSession` if some session alteration is needed.
-
-If you seek a closer cooperation with [Apache
-Maven](http://maven.apache.org/) and want to read configuration from the
-user's `settings.xml`, you should have a look at the library
-[MIMA](https://github.com/maveniverse/mima) which provides the necessary
-bits. Please direct any questions regarding usage of that library to the
-Maven mailing list.
+Only the local repository must be specified. The other settings have default values.
+
+Read the API documentation for `RepositorySystemSession.SessionBuilder` to learn about all the settings for a session.
+
+If you use a Maven plugin or run code embedded in Maven, the session is already created for you. You can derive a new session with the copy constructor of `DefaultRepositorySystemSession` if you must alter the session.
+
+To read configuration from the user's `settings.xml` in a non-Maven project, use the [MIMA](https://github.com/maveniverse/mima) library. MIMA provides the necessary parts. Direct any questions about MIMA to the Maven mailing list.

Review Comment:
   This was a deliberate human rewrite following the initial LLM edit. 



-- 
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-unsubscribe@maven.apache.org

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


Re: [PR] docs: rewrite creating-a-repository-system-session.md to STE rules [maven-resolver]

Posted by "gnodet (via GitHub)" <gi...@apache.org>.
gnodet commented on code in PR #2034:
URL: https://github.com/apache/maven-resolver/pull/2034#discussion_r3721013348


##########
src/site/markdown/creating-a-repository-system-session.md:
##########
@@ -44,18 +37,10 @@ import org.eclipse.aether.supplier.RepositorySystemSupplier;
     }
 ```
 
-As you see, the only setting that must be specified is the local
-repository, other settings are initialized with default values. Please
-have a look at the API docs for `RepositorySystemSession.SessionBuilder` to
-learn about all the other things you can configure for a session.
-
-In case of Maven plugin, or when code runs embedded in Maven, the session
-is already created for you, but you can still "derive" using copy constructor
-of `DefaultRepositorySystemSession` if some session alteration is needed.
-
-If you seek a closer cooperation with [Apache
-Maven](http://maven.apache.org/) and want to read configuration from the
-user's `settings.xml`, you should have a look at the library
-[MIMA](https://github.com/maveniverse/mima) which provides the necessary
-bits. Please direct any questions regarding usage of that library to the
-Maven mailing list.
+Only the local repository must be specified. The other settings have default values.
+
+Read the API documentation for `RepositorySystemSession.SessionBuilder` to learn about all the settings for a session.
+
+If you use a Maven plugin or run code embedded in Maven, the session is already created for you. You can derive a new session with the copy constructor of `DefaultRepositorySystemSession` if you must alter the session.
+
+To read configuration from the user's `settings.xml` in a non-Maven project, use the [MIMA](https://github.com/maveniverse/mima) library. MIMA provides the necessary parts. Direct any questions about MIMA to the Maven mailing list.

Review Comment:
   The `[Apache Maven](http://maven.apache.org/)` hyperlink from the original was dropped. The PR description states "Preserved the code example and all links verbatim," but this link is missing. STE governs language simplification, not navigational markup — please restore the link.
   
   Also, the original's "seek a closer cooperation with Apache Maven" was broader than the rewrite's "in a non-Maven project" — the original implies any project wanting tighter Maven integration, not only non-Maven projects.
   
   ```suggestion
   To integrate more closely with [Apache Maven](http://maven.apache.org/) and read configuration from the user's `settings.xml`, use the [MIMA](https://github.com/maveniverse/mima) library. MIMA provides the necessary parts. Direct any questions about MIMA to the Maven mailing list.
   ```



-- 
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-unsubscribe@maven.apache.org

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