Add documentation for configuring Maven with a private repository for… #704
Conversation
… SCIP-JAVA private-maven-repository-configuration-scip-java.mdx - Added a new Markdown file detailing the steps to configure Maven to use a private Nexus or Artifactory repository for SCIP-JAVA indexing. - Includes guidance for single repository testing and automated configuration across multiple repositories via Sourcegraph's Lua inference script. - Docs placed under the Code Navigation section to aid users in secure dependency management for SCIP-JAVA.
Rhia2
requested review from
airamare01,
antonsviridov-src and
varungandhi-src
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
Hey @Rhia2 is this content categorized as an independent guide or tutorial? Or it's related to a product feature? |
| @@ -0,0 +1,85 @@ | |||
| ### Configuring Maven to Use a Private Repository for SCIP-JAVA | |||
There was a problem hiding this comment.
scip-java is not capitalised anywhere in the documentation (afaik), I think it should be consistent with its own documentation: https://sourcegraph.github.io/scip-java/docs/getting-started.html
There was a problem hiding this comment.
Thanks for the feedback, Anton! You're right that consistency is important. However, this documentation is primarily focused on the auto-indexing process, with scip-java used as an example to demonstrate how to configure Maven with a private repository. Given that, do you think it would be clearer to frame the doc around auto-indexing in general, rather than focusing specifically on scip-java?
I've updated it to focus on configuring a private Maven repository for auto-indexing. Could you please review the changes and share your thoughts?
docs/code-search/code-navigation/private-maven-repository-configuration-scip-java.mdx
Outdated
Show resolved
Hide resolved
|
|
||
| #### Step 1: Testing the Configuration on a Single Repository | ||
|
|
||
| To test and validate the Maven configuration, start by modifying a single repository’s auto-indexing settings to include a custom `settings.xml` file. |
There was a problem hiding this comment.
Perhaps it's worth linking to Maven's offical docs for this file: https://maven.apache.org/settings.html#quick-overview on the off chance that the person configuring this might not be familiar with this part of setup (as is often the case when developers work on virtual machines/thin clients that have everything setup for them, as opposed to personal laptops)
docs/code-search/code-navigation/private-maven-repository-configuration-scip-java.mdx
Outdated
Show resolved
Hide resolved
docs/code-search/code-navigation/private-maven-repository-configuration-scip-java.mdx
Outdated
Show resolved
Hide resolved
docs/code-search/code-navigation/private-maven-repository-configuration-scip-java.mdx
Outdated
Show resolved
Hide resolved
docs/code-search/code-navigation/private-maven-repository-configuration-scip-java.mdx
Outdated
Show resolved
Hide resolved
…iguration-scip-java.mdx Co-authored-by: Anton Sviridov <[email protected]>
Hi @MaedahBatool, this tutorial is related to auto-indexing, and I plan to include it in the "How-to" section for Auto Indexing or Precise Code Intelligence. |
…ory-configuration-scip-java.mdx" This reverts commit 3e60a68.
|
@Rhia2 if you're done addressing the feedback, could you re-request review from Anton? |
|
Hey @antonsviridov-src, can you please tell me the status of this PR? Should I merge it? I have shipped some improvements to it. From my side, I believe it's ready to go live. |
|
@MaedahBatool thanks for the changes – I added small changes (using lowercase scip-java name, as we never capitalise it, and fixing formatting in some steps). With that, it's good to go from my side as well |
4 participants
… SCIP-JAVA private-maven-repository-configuration-scip-java.mdx
Pull Request approval
Although pull request approval is not enforced for this repository in order to reduce friction, merging without a review will generate a ticket for the docs team to review your changes. So if possible, have your pull request approved before merging.