[Docs]: Add more info about environment IDs

[royra]

what's wrong with the documentation?

Users do not know about environment ID and what's it used for. They are confused as to when new environments are created or updated, because it depends on the environment ID, which in turn is either specified explicitly or calculated based on the branch name and project directory.

Add a section in the doc detailing this with references from the up command doc and intro.

Add screenshots

none

Record

• [X] I agree to follow this project's Code of Conduct

[anshulkansal04]

Hello royra,

I've been going through the Preevy documentation and noticed that there's room for a detailed section on the "Environment ID", its significance, and its operations.

I've drafted a comprehensive explanation, which I believe will be beneficial for users to understand the importance of the Environment ID, how it's derived, and its role in creating or updating environments.

Would it be possible to assign this task to me? I'm eager to contribute and believe this addition will greatly enhance the clarity of the documentation.

Thank you for considering!

Best regards, Anshul Kansal

[iamjaredwalters]

Tangentially, are environment ID's assignable in the preevy github action?

[Yshayy]

@iamjaredwalters, I think you can use the input.args command to add additional arg: --id=desired-id https://github.com/livecycle/preevy-up-action/blob/master/action.yml#L11C3-L11C7 https://github.com/livecycle/preevy-down-action/blob/master/action.yml#L11C3-L11C7

[parthasdey2304]

Would you please assign that to me.