Closed tanmaygarg-oracle closed 1 year ago
@rishiagarwal-oracle fixed the linter. Only infos are appearing now in the report.
@tanmaygarg-oracle please add copyright to the files
I've switched this to draft mode so that you can provide documentation and context as to why these files belong in this repo, because right now it seems like they would be better suited for a sample repo, not this one.
@Djelibeybi For On-Premises deployments, these files were bundled within the shiphome package and customers extracted and utilized them from that source. However, for containerized environments, we will advise customers to directly retrieve and utilize these files from the GitHub repository. It's important to note that these files are intended to be used by the customers in their original form, without any modifications.
Customers have to download the binaries to build the image in the first place. Why can't you just document how to extract these files during the build process?
These files are currently distributed via the Oracle Technology Network (OTN) specifically for facilitating the integration between Oracle Identity Governance (OIG) and OIG connectors. It is important to note that these binaries are separate and distinct from the ones necessary for building Docker containers.
My concern is duplication of distribution: I'd rather additional documentation be added to explain how to find and download these files from OTN, so that they don't have to be maintained in both locations. Whenever content is duplicated, it generally drifts out of date/sync and thus results in user issues/imcompatibility.
Is there a reason why this can't just be documented as above? Or if this is documented already on docs.oracle.com, a link added for users to follow who want to use these files?
@Djelibeybi with containers, we are trying to make the customer experience better. The old approach is very cumbersome for customers. They have to manually download from OTN and extract files and run them. With the new approach it will work in a seamless, automated fashion for customers.
We are enforcing internal process to make sure, things are always pushed to both the delivery channels.
Fair enough and I'm glad to hear about the internal process.
Is it possible to at least add some documentation that explains what these files are for and when they're used?
@Djelibeybi agreed @tanmaygarg-oracle please add a readme in the scripts folder stating the purpose of these files
@Djelibeybi I have added the read me stating the purpose of the scripts
I've sent a review request to @rishiagarwal-oracle. Once they approve the PR, I'll merge it.
Please fix the issues reported by shellcheck