Skip to content

Commit

Permalink
#5 📝 Tranche 7 of documentation migration; with PR feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
d-ryan-ashcraft committed May 2, 2024
1 parent 482c4d4 commit a7bbece
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 22 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,17 +33,16 @@ In addition, the following build tools and container frameworks are an important

### Detailed Documentation

aiSSEMBLE documentation will be posted on GitHub pages along with this repository. We are [actively porting our existing
documentation](https://github.com/boozallen/aissemble/issues/5) and will update this section with a link as soon as it is up and available.
[aiSSEMBLE documentation is available GitHub pages](https://boozallen.github.io/aissemble).

### aiSSEMBLE Releases

aiSSEMBLE is currently released about once a month, but we intend to increase to around twice a month as we get our
processes adjusted and honed into the public GitHub

## Configurations
## Environment Configuration

For details on using the configuration tool, please consult our [Configuring Your Environment guidance](https://boozallen.github.io/aissemble/aissemble/current/configurations.html).
Please consult our [Configuring Your Environment guidance](https://boozallen.github.io/aissemble/aissemble/current/configurations.html).

## Build

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/databricks.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ you can set the following parameters:
spark.driver.extraJavaOptions
-DKRAUSENING_BASE=/dbfs/FileStore/shared_uploads/project-name/krausening/base
-DKRAUSENING_EXTENSIONS=/dbfs/FileStore/shared_uploads/project-name/krausening/databricks
-DKRAUSENING_PASSWORD=3uQ2j_=wmP5A2q8b
-DKRAUSENING_PASSWORD=<YOUR PASSWORD_HERE>
7. When you are done configuring, select `Create Cluster`
Expand Down
5 changes: 0 additions & 5 deletions docs/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,5 @@
= aiSSEMBLE(TM) User Manual

[NOTE]
April 30, 2024: We are rolling out our documentation actively. You may find these pages incomplete or missing links
until this process is completed. Please see https://github.com/boozallen/aissemble/issues/5[the associated
GitHub issue,role=external,window=_blank] for more information.
== Key Terms
* **aiSSEMBLE** – (pronounced assemble) is Booz Allen’s lean, manufacturing-inspired approach for holistically designing,
developing, and fielding AI solutions across the engineering lifecycle: from data processing (DataOps) to model building,
Expand Down
18 changes: 9 additions & 9 deletions docs/modules/ROOT/pages/path-to-production.adoc
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
= Path to Production

Aside from testing scaffolding and the Maven project structure, aiSSEMBLE(TM) generates several artifacts to help drive
consistency, repeatability, and quality of delivery. These artifacts are designed as starting points for a mature
DevOps-centric approach for delivering high-quality AI systems and are not intended as complete solutions in and of
themselves.
aiSSEMBLE(TM) generates several artifacts to help drive consistency, repeatability, and quality of delivery. These
artifacts are designed as starting points for a mature DevOps-centric approach for delivering high-quality AI systems
and are not intended as complete solutions in and of themselves.

== Mapping to aiSSEMBLE Concepts
[#img-you-are-here-path-to-production]
.xref:solution-baseline-process.adoc[You Are Here]
image::you-are-here-path-to-production.png[You Are Here,200,100,role="thumb right"]

_Path to Production_: Many AI systems are developed across the industry much like a school project - a Data Engineer or
_Path to Production_: Many AI systems are developed across the industry leverage ad-hoc, manual processes - a Data Engineer or
Data Scientist exports local code via a container and pushes that into production. This practice was once rampant in
software development as well. Over time, it has become an industry best practice to leverage a repeatable, consistent
_path to production_ to ensure quality and enable higher-velocity delivery. It's critical to recognize that while
slower for an initial deployment, the speed and repeatability of this process are amongst the most important enablers in
moving faster over time (an attribute most clients revere).
software development as well. Over time, it has become an industry best practice to leverage automation to establish a
repeatable, consistent _path to production_ to ensure quality and enable higher-velocity delivery. It's critical to
recognize that while slower for an initial deployment, the speed and repeatability of this process are amongst the
most important enablers in enabling the an effort to movie fast over time (an attribute most clients revere as it
allows ongoing responsiveness and impact for their customers).

== Containers

Expand Down
6 changes: 3 additions & 3 deletions docs/modules/ROOT/pages/security-configuration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ pipeline scripts. The following is an example of a simple property file.
# GENERATED PROPERTIES FILE - please ***DO*** modify.
pdp_host_url=http://policy-decision-point:8080/api/pdp
is_authorization_enabled = True
is_authorization_enabled = true
----

When a new project is created security will be enabled by default and a policy-decision-point-docker module will be
generated which needs to be added to your build process.
If you decide to disable security you will need to change the configuration.
This can be accomplished by updating the `auth.properties` file and changing `is_authorization_enabled = True` to
`is_authorization_enabled = False`. This change is activated by rebuilding your Docker image.
This can be accomplished by updating the `auth.properties` file to include `is_authorization_enabled = false`. This
change is activated by rebuilding your Docker image.

0 comments on commit a7bbece

Please sign in to comment.