Rearranging files and directories (Esri#93)

* docs: adds link to CONTRIBUTING.md * Rearranging files and directories to comply with established conventions. Related to Esri#77 and more * Fixing solutions name and link * Rearrenging toolboxes * Removing unnecesary README.md * Moving attribute-assistant and dictionary-renderer and removing AttributesRulesTools*
shoe913 · Oct 9, 2024 · 66f12ba · 66f12ba
1 parent 46cb11b
commit 66f12ba
Show file tree

Hide file tree

Showing 187 changed files with 147 additions and 402 deletions.
diff --git a/HelperTools/AttributeRulesTools.ApplyIndustryRulesGP.pyt.xml b/HelperTools/AttributeRulesTools.ApplyIndustryRulesGP.pyt.xml
diff --git a/HelperTools/AttributeRulesTools.pyt b/HelperTools/AttributeRulesTools.pyt
diff --git a/HelperTools/AttributeRulesTools.pyt.xml b/HelperTools/AttributeRulesTools.pyt.xml
diff --git a/Industry/README.md b/Industry/README.md
diff --git a/README.md b/README.md
@@ -1,17 +1,16 @@
 # ArcGIS Arcade expressions
 
-This repository is intended for sharing and maintaining reuseable Arcade expressions across all supported profiles.
+This repository is intended for sharing and maintaining reuseable Arcade expressions across all supported profiles, and some helper tools to create Arcade Expressions.
 
 ## General workflow
 
 These expressions are organized based on their intended [execution profile](https://developers.arcgis.com/arcade/guide/profiles/). The following folders correspond with each profile:
 
 * [Any](./any)
 * [Alias](./alias)
-* [Calculation](./attribute_rule_calculation)
-* [Constraint](./constraint)
-* [Dashboard data](./dashboard_data)
-* [Form Calculation](./form_calculation/)
+* [Attribute rules](./attribute-rules)
+* [Dashboard](./dashboard)
+* [Form calculation](./form_calculation/)
 * [Labeling](./labeling)
 * [Popup](./popup)
 * [Visualization](./visualization)
@@ -22,6 +21,10 @@ Click on the desired profile name to view relevant expressions.
 
 Each expression lives in a Markdown file, which contains a general description of the expression, its use case, a depiction of the result, the code to copy, and an example of an executable form of the expression along with its output. It may also include a link to a web map demonstrating the expression in action.
 
+## Helper tools
+
+In [helper-tools](./helper-tools/) you will find tools to help you create Arcade Expressions.
+
 ## Resources
 
 * [ArcGIS Arcade Documentation](https://developers.arcgis.com/arcade/guide/)

diff --git a/any/README.md b/any/README.md
@@ -15,6 +15,7 @@ See the list below for shared expressions.
 * [Barcode - Gas Component Manufacturer](./barcode-gas/barcode-gas-manufacturer.md)
 * [Barcode - Gas Component Material](./barcode-gas/barcode-gas-material.md)
 * [Barcode - Gas Component Production Date](./barcode-gas/barcode-gas-productionDate.md)
+* [Constraint expressions](./constraint-expressions)
 * [Sandbag Wall Estimation - Sandbags](./sandbag-wall-estimation/sandbag-estimate.md)
 * [Sandbag Wall Estimation - Sand](./sandbag-wall-estimation/sand-estimate.md)
 * [Sandbag Wall Estimation - Sheeting](./sandbag-wall-estimation/sheeting-estimate.md)

diff --git a/constraint/README.md → any/constraint-expressions/README.md b/constraint/README.md → any/constraint-expressions/README.md
diff --git a/...raint/constainValueBySubtypeOtherField.md → ...sions/constainValueBySubtypeOtherField.md b/...raint/constainValueBySubtypeOtherField.md → ...sions/constainValueBySubtypeOtherField.md
diff --git a/constraint/constrainToDomainCode.md → ...aint-expressions/constrainToDomainCode.md b/constraint/constrainToDomainCode.md → ...aint-expressions/constrainToDomainCode.md
diff --git a/arcade-expression-template.md b/arcade-expression-template.md
@@ -9,10 +9,10 @@
 ## Workflow
 
 > Explain the necessary steps to test the expression: 
-> * Add any notes related to backwards compatibility (e.g. [Calculations across fields](https://github.com/Esri/arcade-expressions/blob/master/dashboard_data/CalculationAcrossFields.md)) (if needed).
+> * Add any notes related to backwards compatibility (e.g. [Calculations across fields](./dashboard/dashboard_data/CalculationAcrossFields.md)) (if needed).
 > * Specify changes to be made (e.g. [how to replace variables](https://github.com/Esri/arcade-expressions/blob/master/popup/url-basic.md#dynamically-create-a-hyperlink-in-a-popup)).
 > * List of the product(s) supported.
-> * Configuration requirements (e.g. [attribute rule values](https://github.com/Esri/arcade-expressions/blob/master/attribute_rule_validation/require_reducer.md#workflow), service description, ...).
+> * Configuration requirements (e.g. [attribute rule values](./attribute-rules/attribute_rule_validation/require_reducer.md#workflow), service description, ...).
 > * Using the provided sample data versus your own data (e.g. [sample vs own data](https://github.com/Esri/arcade-expressions/blob/master/dictionary_renderer/Conduit/Readme.md#workflow)). If sample data is provided, reference it.
 
 
@@ -22,7 +22,7 @@
 
 ## Expression Template
 
-> Add any necessary clarifications. Instead of embedding the example code, you may also reference an external file (e.g. [create points along line](https://github.com/Esri/arcade-expressions/blob/master/attribute_rule_calculation/CreatePointsAlongLine.md)).
+> Add any necessary clarifications. Instead of embedding the example code, you may also reference an external file (e.g. [create points along line](./attribute-rules/attribute_rule_calculation/CreatePointsAlongLine.md)).
 
 ```js
 // Your code here (comments are allowed)

diff --git a/attribute-rules/README.md b/attribute-rules/README.md
@@ -0,0 +1,41 @@
+# Attribute rules expressions
+
+This folder contains Arcade expression templates and functions that may be used in the [attribute rules profile](https://developers.arcgis.com/arcade/profiles/attribute-rules/).
+
+## General workflow
+
+Each expression lives in a Markdown file, which contains a general description of the expression, its use case, a depiction of the result, the code to copy, and an example of an executable form of the expression along with its output. It may also include a link to a web map demonstrating the expression in action.
+
+See the list below for shared expressions.
+
+* [Attribute rules assistant](./attribute_assistant/)
+* [Attribute rules calculation](./attribute_rule_calculation/)
+* [Attribute rules constraint](./attribute_rule_constraint/)
+* [Attribute rules validation](./attribute_rule_validation/)
+
+## Resources
+
+* [ArcGIS Arcade Documentation](https://developers.arcgis.com/arcade/)
+* [ArcGIS Arcade Playground](https://developers.arcgis.com/arcade/playground/)
+
+## Contributing
+
+Esri welcomes [contributions](CONTRIBUTING.md) from anyone and everyone. Please see our [guidelines for contributing](https://github.com/esri/contributing).
+
+## License
+
+Copyright 2024 Esri
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+A copy of the license is available in the repository's [LICENSE](LICENSE) file.
diff --git a/attribute_assistant/AttributeAssistant.atbx → ...tribute_assistant/AttributeAssistant.atbx b/attribute_assistant/AttributeAssistant.atbx → ...tribute_assistant/AttributeAssistant.atbx
diff --git a/attribute_assistant/readme.md → ...ibute-rules/attribute_assistant/readme.md b/attribute_assistant/readme.md → ...ibute-rules/attribute_assistant/readme.md
diff --git a/attribute_rule_calculation/CalcEdgeFields.md → ...ribute_rule_calculation/CalcEdgeFields.md b/attribute_rule_calculation/CalcEdgeFields.md → ...ribute_rule_calculation/CalcEdgeFields.md
diff --git a/...te_rule_calculation/CalcJunctionFields.md → ...te_rule_calculation/CalcJunctionFields.md b/...te_rule_calculation/CalcJunctionFields.md → ...te_rule_calculation/CalcJunctionFields.md
diff --git a/...ibute_rule_calculation/CalcSlopeOfLine.md → ...ibute_rule_calculation/CalcSlopeOfLine.md b/...ibute_rule_calculation/CalcSlopeOfLine.md → ...ibute_rule_calculation/CalcSlopeOfLine.md
diff --git a/..._calculation/CalcVolumeSurfaceAreaPipe.md → ..._calculation/CalcVolumeSurfaceAreaPipe.md b/..._calculation/CalcVolumeSurfaceAreaPipe.md → ..._calculation/CalcVolumeSurfaceAreaPipe.md
diff --git a/...calculation/CalcVolumeSurfaceAreaPipe.zip → ...calculation/CalcVolumeSurfaceAreaPipe.zip b/...calculation/CalcVolumeSurfaceAreaPipe.zip → ...calculation/CalcVolumeSurfaceAreaPipe.zip
diff --git a/...rule_calculation/CalculateTopElevation.md → ...rule_calculation/CalculateTopElevation.md b/...rule_calculation/CalculateTopElevation.md → ...rule_calculation/CalculateTopElevation.md
diff --git a/...calculation/ContainAndJunctionJunction.md → ...calculation/ContainAndJunctionJunction.md b/...calculation/ContainAndJunctionJunction.md → ...calculation/ContainAndJunctionJunction.md
diff --git a/...on/ContainFeatureInContainerUsingRules.js → ...on/ContainFeatureInContainerUsingRules.js b/...on/ContainFeatureInContainerUsingRules.js → ...on/ContainFeatureInContainerUsingRules.js
diff --git a/..._rule_calculation/CopyStartEndZtoField.md → ..._rule_calculation/CopyStartEndZtoField.md b/..._rule_calculation/CopyStartEndZtoField.md → ..._rule_calculation/CopyStartEndZtoField.md
diff --git a/...lculation/CopyValueIntersectingFeature.md → ...lculation/CopyValueIntersectingFeature.md b/...lculation/CopyValueIntersectingFeature.md → ...lculation/CopyValueIntersectingFeature.md
diff --git a/...culation/CopyValueIntersectingFeature.zip → ...culation/CopyValueIntersectingFeature.zip b/...culation/CopyValueIntersectingFeature.zip → ...culation/CopyValueIntersectingFeature.zip
diff --git a/...ute_rule_calculation/CreateAssociation.md → ...ute_rule_calculation/CreateAssociation.md b/...ute_rule_calculation/CreateAssociation.md → ...ute_rule_calculation/CreateAssociation.md
diff --git a/...CreateAttachmentAssociationByProximity.md → ...CreateAttachmentAssociationByProximity.md b/...CreateAttachmentAssociationByProximity.md → ...CreateAttachmentAssociationByProximity.md
diff --git a/attribute_rule_calculation/CreateLateral.js → ...tribute_rule_calculation/CreateLateral.js b/attribute_rule_calculation/CreateLateral.js → ...tribute_rule_calculation/CreateLateral.js
diff --git a/...tion/CreateLateralDevSummitPlenary2023.js → ...tion/CreateLateralDevSummitPlenary2023.js b/...tion/CreateLateralDevSummitPlenary2023.js → ...tion/CreateLateralDevSummitPlenary2023.js
diff --git a/...tion/CreateLateralDevSummitPlenary2023.md → ...tion/CreateLateralDevSummitPlenary2023.md b/...tion/CreateLateralDevSummitPlenary2023.md → ...tion/CreateLateralDevSummitPlenary2023.md
diff --git a/...ion/CreateLateralDevSummitPlenary2023.zip → ...ion/CreateLateralDevSummitPlenary2023.zip b/...ion/CreateLateralDevSummitPlenary2023.zip → ...ion/CreateLateralDevSummitPlenary2023.zip
diff --git a/...rule_calculation/CreatePointsAlongLine.js → ...rule_calculation/CreatePointsAlongLine.js b/...rule_calculation/CreatePointsAlongLine.js → ...rule_calculation/CreatePointsAlongLine.js
diff --git a/...rule_calculation/CreatePointsAlongLine.md → ...rule_calculation/CreatePointsAlongLine.md b/...rule_calculation/CreatePointsAlongLine.md → ...rule_calculation/CreatePointsAlongLine.md
diff --git a/...ule_calculation/CreatePointsAlongLine.zip → ...ule_calculation/CreatePointsAlongLine.zip b/...ule_calculation/CreatePointsAlongLine.zip → ...ule_calculation/CreatePointsAlongLine.zip
diff --git a/...e_calculation/CreateStrandFiberContent.md → ...e_calculation/CreateStrandFiberContent.md b/...e_calculation/CreateStrandFiberContent.md → ...e_calculation/CreateStrandFiberContent.md
diff --git a/..._calculation/CreateStrandFiberContent.zip → ..._calculation/CreateStrandFiberContent.zip b/..._calculation/CreateStrandFiberContent.zip → ..._calculation/CreateStrandFiberContent.zip
diff --git a/attribute_rule_calculation/GenerateID.md → .../attribute_rule_calculation/GenerateID.md b/attribute_rule_calculation/GenerateID.md → .../attribute_rule_calculation/GenerateID.md
diff --git a/...e_calculation/GetAddressFromCenterline.js → ...e_calculation/GetAddressFromCenterline.js b/...e_calculation/GetAddressFromCenterline.js → ...e_calculation/GetAddressFromCenterline.js
diff --git a/...e_calculation/GetAddressFromCenterline.md → ...e_calculation/GetAddressFromCenterline.md b/...e_calculation/GetAddressFromCenterline.md → ...e_calculation/GetAddressFromCenterline.md
diff --git a/..._calculation/GetAddressFromCenterline.zip → ..._calculation/GetAddressFromCenterline.zip b/..._calculation/GetAddressFromCenterline.zip → ..._calculation/GetAddressFromCenterline.zip
diff --git a/attribute_rule_calculation/LastValue.gdb.zip → ...ribute_rule_calculation/LastValue.gdb.zip b/attribute_rule_calculation/LastValue.gdb.zip → ...ribute_rule_calculation/LastValue.gdb.zip
diff --git a/attribute_rule_calculation/LastValue.js → ...s/attribute_rule_calculation/LastValue.js b/attribute_rule_calculation/LastValue.js → ...s/attribute_rule_calculation/LastValue.js
diff --git a/attribute_rule_calculation/LastValue.md → ...s/attribute_rule_calculation/LastValue.md b/attribute_rule_calculation/LastValue.md → ...s/attribute_rule_calculation/LastValue.md
diff --git a/...ute_rule_calculation/MoveFieldToParent.js → ...ute_rule_calculation/MoveFieldToParent.js b/...ute_rule_calculation/MoveFieldToParent.js → ...ute_rule_calculation/MoveFieldToParent.js
diff --git a/attribute_rule_calculation/README.md → ...ules/attribute_rule_calculation/README.md b/attribute_rule_calculation/README.md → ...ules/attribute_rule_calculation/README.md
diff --git a/..._calculation/ReturnValueBaseOnCriteria.md → ..._calculation/ReturnValueBaseOnCriteria.md b/..._calculation/ReturnValueBaseOnCriteria.md → ..._calculation/ReturnValueBaseOnCriteria.md
diff --git a/...ulation/RotateFeatureByIntersectedLine.md → ...ulation/RotateFeatureByIntersectedLine.md b/...ulation/RotateFeatureByIntersectedLine.md → ...ulation/RotateFeatureByIntersectedLine.md
diff --git a/...lation/RotateFeatureByIntersectedLine.zip → ...lation/RotateFeatureByIntersectedLine.zip b/...lation/RotateFeatureByIntersectedLine.zip → ...lation/RotateFeatureByIntersectedLine.zip
diff --git a/attribute_rule_calculation/SetMValues.md → .../attribute_rule_calculation/SetMValues.md b/attribute_rule_calculation/SetMValues.md → .../attribute_rule_calculation/SetMValues.md
diff --git a/attribute_rule_calculation/SetMsToIndex.md → ...ttribute_rule_calculation/SetMsToIndex.md b/attribute_rule_calculation/SetMsToIndex.md → ...ttribute_rule_calculation/SetMsToIndex.md
diff --git a/...rule_calculation/SplitIntersectingLine.md → ...rule_calculation/SplitIntersectingLine.md b/...rule_calculation/SplitIntersectingLine.md → ...rule_calculation/SplitIntersectingLine.md
diff --git a/...ule_calculation/SplitIntersectingLine.zip → ...ule_calculation/SplitIntersectingLine.zip b/...ule_calculation/SplitIntersectingLine.zip → ...ule_calculation/SplitIntersectingLine.zip
diff --git a/...e_calculation/UpdateAssociatedFeatures.md → ...e_calculation/UpdateAssociatedFeatures.md b/...e_calculation/UpdateAssociatedFeatures.md → ...e_calculation/UpdateAssociatedFeatures.md
diff --git a/...ulation/UpdateContainerViaAssociations.md → ...ulation/UpdateContainerViaAssociations.md b/...ulation/UpdateContainerViaAssociations.md → ...ulation/UpdateContainerViaAssociations.md
diff --git a/...pdateContainersGeometryViaAssociations.md → ...pdateContainersGeometryViaAssociations.md b/...pdateContainersGeometryViaAssociations.md → ...pdateContainersGeometryViaAssociations.md
diff --git a/...rule_calculation/UpdateContentLocation.md → ...rule_calculation/UpdateContentLocation.md b/...rule_calculation/UpdateContentLocation.md → ...rule_calculation/UpdateContentLocation.md
diff --git a/..._calculation/UpdateIntersectingFeature.md → ..._calculation/UpdateIntersectingFeature.md b/..._calculation/UpdateIntersectingFeature.md → ..._calculation/UpdateIntersectingFeature.md
diff --git a/...calculation/UpdateIntersectingFeature.zip → ...calculation/UpdateIntersectingFeature.zip b/...calculation/UpdateIntersectingFeature.zip → ...calculation/UpdateIntersectingFeature.zip
diff --git a/...e_rule_calculation/UpdateParentFeature.md → ...e_rule_calculation/UpdateParentFeature.md b/...e_rule_calculation/UpdateParentFeature.md → ...e_rule_calculation/UpdateParentFeature.md
diff --git a/..._rule_calculation/UpdateParentFeature.zip → ..._rule_calculation/UpdateParentFeature.zip b/..._rule_calculation/UpdateParentFeature.zip → ..._rule_calculation/UpdateParentFeature.zip