Skip to content

Commit

Permalink
docs: improve README files (Esri#92)
Browse files Browse the repository at this point in the history
This commit changes some of the repo README files to improve them in the following aspects:

- add missing references to existing attribute rules in the *See the list below for shared expressions* sections
- add the section *See the list below for shared expressions* where it is currently missing (e.g. dashboard_data folder)
- alphabetically sort the entries in the *See the list below for shared expressions*
- standardize the rule descriptions by consistently using sentence case

Co-authored-by: Roberto Pepato <[email protected]>
  • Loading branch information
pepato-bzp and rpepato authored Oct 7, 2024
1 parent 62cfd2f commit 46cb11b
Show file tree
Hide file tree
Showing 7 changed files with 59 additions and 16 deletions.
8 changes: 4 additions & 4 deletions any/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ Each expression lives in a Markdown file, which contains a general description o

See the list below for shared expressions.

* [Weekdays](./weekdays.md)
* [Unit Conversion](./unit-conversion.md)
* [Attribute from Intersection](./attributeFromLargestArea.md)
* [Barcode - Gas Component Type](./barcode-gas/barcode-gas-componenttype.md)
* [Barcode - Gas Component Size](./barcode-gas/barcode-gas-componentsize.md)
Expand All @@ -20,8 +18,10 @@ See the list below for shared 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)
* [Relative Humidity](./weather-observation/relative-humidity.md)
* [Heat Index](./weather-observation/heat-index.md)
* [Unit Conversion](./unit-conversion.md)
* [Weather Observation - Relative Humidity](./weather-observation/relative-humidity.md)
* [Weather Observation - Heat Index](./weather-observation/heat-index.md)
* [Weekdays](./weekdays.md)

## Resources

Expand Down
39 changes: 29 additions & 10 deletions attribute_rule_calculation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,35 @@ Each expression lives in a Markdown file, which contains a general description o
See the list below for shared expressions.

- [Calc Slope of Line](./CalcSlopeOfLine.md)
- [Calculate Top Elevation](./CalculateTopElevation.md)
- [Copy Start or End Z of a line to a field](./CopyStartEndZtoField.md)
- [Calculate Volume or Surface area of a pipe or line](./CalcVolumeSurfaceAreaPipe.md)
- [Copy a Value from an Intersecting Feature](./CopyValueIntersectingFeature.md)
- [Generate Unique ID](./GenerateID.md)
- [Return Value Base On Criteria](./ReturnValueBaseOnCriteria.md)
- [Rotate Feature by Intersected Line](./RotateFeatureByIntersectedLine.md)
- [Update Associated Features](./UpdateAssociatedFeatures.md)
- [Update Parent Features](./UpdateParentFeature.md)
- [Calculate attributes from edge](./CalcEdgeFields.md)
- [Calculate attributes from junction](./CalcJunctionFields.md)
- [Calculate M values of a line using vertex distance](./SetMValues.md)
- [Calculate slope of line](./CalcSlopeOfLine.md)
- [Calculate top elevation](./CalculateTopElevation.md)
- [Calculate volume or surface area of a pipe or line](./CalcVolumeSurfaceAreaPipe.md)
- [Contain feature in a container within a search distance](./ContainFeatureInContainerUsingRules.js)
- [Copy start or end Z of a line to a field](./CopyStartEndZtoField.md)
- [Copy a value from an intersecting feature](./CopyValueIntersectingFeature.md)
- [Create a junction to junction association when a feature is placed](./CreateAssociation.md)
- [Create attachment to structure within distance](./CreateAttachmentAssociationByProximity.md)
- [Create content in a line](./ContainAndJunctionJunction.md)
- [Create laterals](./CreateLateralDevSummitPlenary2023.md)
- [Create points along line](./CreatePointsAlongLine.md)
- [Create strand fiber content](./CreateStrandFiberContent.md)
- [Generate unique ID](./GenerateID.md)
- [Get address from centerline](./GetAddressFromCenterline.md)
- [Last value](./LastValue.md)
- [Return value base on criteria](./ReturnValueBaseOnCriteria.md)
- [Rotate feature by intersected line](./RotateFeatureByIntersectedLine.md)
- [Set Ms to index](./SetMsToIndex.md)
- [Split intersecting line](./SplitIntersectingLine.md)
- [Update an attribute in the parent feature](./MoveFieldToParent.js)
- [Update an intersecting feature](./UpdateIntersectingFeature.md)
- [Update associated features](./UpdateAssociatedFeatures.md)
- [Update container feature when content is changed](./UpdateContainerViaAssociations.md)
- [Update container and structures associated features location](./UpdateContentLocation.md)
- [Update containers Z value when feature is the lowest feature](./UpdateContainersGeometryViaAssociations.md)
- [Update parent features](./UpdateParentFeature.md)


## Resources
Expand Down
4 changes: 3 additions & 1 deletion attribute_rule_constraint/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,10 @@ Each expression lives in a Markdown file, which contains a general description o
See the list below for shared expressions.

- [Only allow the point to be at the start of end of a line](./only_at_start_end.md)
- [Reject too many related features](./reject_too_many_related.md)
- [Restrict Editing](./restrict_edting.md)
- [Restrict editing](./restrict_edting.md)
- [Restrict editing - prevent delete](./prevent_delete.md)


## Resources
Expand Down
3 changes: 2 additions & 1 deletion attribute_rule_validation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ Each expression lives in a Markdown file, which contains a general description o
See the list below for shared expressions.

- [Validate Related Features Cardinality](./validate_related_cardinality.md)
- [Require reducer on diamater change](./require_reducer.md)
- [Validate related features cardinality](./validate_related_cardinality.md)


## Resources
Expand Down
1 change: 1 addition & 0 deletions constraint/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Each expression lives in a Markdown file, which contains a general description o
See the list below for shared expressions.

- [Constrain value by subtype and other field](./constainValueBySubtypeOtherField.md)
- [Constrain to domain code](./constrainToDomainCode.md)

*There aren't any expression templates or functions shared for this profile.*
Expand Down
14 changes: 14 additions & 0 deletions dashboard_data/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,17 @@
This folder contains sample [data expressions](https://doc.arcgis.com/en/dashboards/get-started/create-data-expressions.htm) and recommended charts. Dashboard authors can create data expressions using the [Arcade function library](https://developers.arcgis.com/arcade/function-reference/) to unlock insights and create robust visualizations. Data expressions are authored, saved, and executed within the context of a Dashboard. They must return [FeatureSets](https://developers.arcgis.com/arcade/guide/types/) which can drive data driven elements in Dashboards. Refer to [best practices for working with data expressions](https://doc.arcgis.com/en/dashboards/reference/authoring-data-expressions.htm) for tips on authoring performant expressions.

Note: Data expressions and advanced formatting in Dashboards are separate [Arcade profiles](https://developers.arcgis.com/arcade/guide/profiles/).

See the list below for shared expressions:

- [Aggregate by day of week](./AggregateByDOW(SerialChart).md)
- [Aggregate by spatial relationship](./SpatialAggregation.md)
- [ArcGIS Workforce - Obtain the the worker name & description of assignment type from a FeatureSet](./WorkforceWorkerNameAssignmentType.md)
- [Calculate a statistic on a virtual field](./GroupBySQLExpressionAverage(SerialChart).md)
- [Calculate multiple statistics using Arcade's GroupBy() function](./GroupByMultiStats(List).md)
- [Calculations across fields](./CalculationAcrossFields.md)
- [Combined multiple layers](./CombineMultipleLayers(SerialChart).md)
- [Get most recent records](./MostRecentRecords(IndicatorOrGuage).md)
- [HAVING clause](./HavingClause(SerialChart).md)
- [Join attributes from a layer to a table](./JoinLayerFieldsToTable.md)
- [Split comma separated values across multiple rows](./SplitCategories(PieChart).md)
6 changes: 6 additions & 0 deletions popup/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,17 @@ Each expression lives in a Markdown file, which contains a general description o
See the list below for shared expressions.

* [Add a date since last update field to a pop-up](./date-since.md)
* [Convert military time to civilian time](./military-to-civilian-time.md)
* [Dynamically create a hyperlink](./url-basic.md)
* [Dynamically create a hyperlink with latitude and longitude values](./url-withlocation.md)
* [Display the operating hours of a facility](./operating-hours.md)
* [Get the current and parent subnetworks in a pop-up](./utility-network-parent-subnetworks.md)
* [Has proposed features](./has_proposed_features.md)
* [Label Survey123 multiple choice questions](./label_Survey123_multiple_choice.md)
* [Match pop-up to map value](./Match-Popup-to-Map-Value.md)
* [Project phase table](./project-phase.md)
* [Return most recent editing summary across multiple tables](./most-recent-edit-across-multiple-tables.md)
* [Style the difference between 2 numeric fields](./numeric-difference.md)
* [Top 5 numbers](./top-five-list.md)

Expand Down

0 comments on commit 46cb11b

Please sign in to comment.