Skip to content

[Docs]: Readme.md; Platform Specific Setup - AI-DLC Rules Folders Copy Commands #261

@mrritesh14

Description

@mrritesh14

Type of Documentation Problem

Incorrect or outdated information

Location

Set up instructions to run the initial commands copying the aws-aidlc-rules and aws-aidlc-rule-details folders from the extracted zip folder and the user download directory do not reflect correctly with the downloaded zip version extracted folders structure in the user downloads folder. Upon extraction, the folder structure is Downloads>ai-dlc-rules-v0.1.8>aidlc-rules. I committed changes just for the windows command prompt instructions. This created confusion among the customer end users when running the AI-DLC workshops.

Description

Set up instructions to run the initial commands copying the aws-aidlc-rules and aws-aidlc-rule-details folders from the extracted zip folder and the user download directory do not reflect correctly with the downloaded zip version extracted folders structure in the user downloads folder. Upon extraction, the folder structure is Downloads>ai-dlc-rules-v0.1.8>aidlc-rules. I committed changes just for the windows command prompt instructions. This created confusion among the customer end users when running the AI-DLC workshops.

Suggested Fix

This situation is creating confusion among the customers during the workshop kick-off. It is better to add the instructions in the platform setup. Currently, platform setup instructions and extracted zip folder structure is not aligned. We can update the document to provide the clear instructions " Update the copy commands for the extracted zip files as per the extracted folder structure in the user's DOWNLOADS folder, flag ai-dlc-rules-version in the file, ask customers to substitute the "version" with the actual version" before running the commands. Validate the extracted zip folder structure, file name and ensure that it reflects correctly in the copy commands for powershell, cmd, and bash.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions