Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add more commands in using-atlantis.md #2808

Merged
merged 9 commits into from Dec 18, 2022

Conversation

krrrr38
Copy link
Contributor

@krrrr38 krrrr38 commented Dec 17, 2022

what

  • add version/unlock/approve_policies commands in unsing-atlantis.md doc
    • add tips about executable name
  • add How Atlantis Works children links
localhost:8080/docs/using-atlantis.html

localhost_8080_docs_using-atlantis html (1)

why

version/unlock/approve_policies commands are not documented in that page.

references

---
## atlantis plan
![Plan Command](./images/pr-comment-plan.png)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's difficult to capture same image for other commands. So just show one image on the page top.


### Explanation
Removes all atlantis locks and discards all plans for this PR.
To unlock a specific plan you can use the Atlantis UI.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

copy from

Commands:
plan Runs 'terraform plan' for the changes in this pull request.
To plan a specific project, use the -d, -w and -p flags.
apply Runs 'terraform apply' on all unapplied plans from this pull request.
To only apply a specific plan, use the -d, -w and -p flags.
unlock Removes all atlantis locks and discards all plans for this PR.
To unlock a specific plan you can use the Atlantis UI.
approve_policies
Approves all current policy checking failures for the PR.
version Print the output of 'terraform version'
help View help.

@krrrr38 krrrr38 marked this pull request as ready for review December 17, 2022 06:41
@krrrr38 krrrr38 requested a review from a team as a code owner December 17, 2022 06:41
* `run` is a global executable name.
* `@GithubUser help`
* `@GithubUser` is the VCS host user which you connected to Atlantis by user token.
:::
Copy link
Contributor Author

@krrrr38 krrrr38 Dec 17, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO it is better to drop run help feature... it seems a little bit hidden function.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's your opinion to drop the run help feature because it's a hidden function?

Wouldn't you want to add the run help feature because it's a hidden function?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I want to remove run help feature. so remove this doc.

ee9777a

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why remove the run help feature?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess no one use run apply and almost users doesnot know this feature. Not to execute it untentionally by just comment it, I think it is better to drop it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's possible people still use it. We don't collect analytics for this. It's probably best not to introduce a breaking change, no?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True. Generally, we should not do a breaking change. it must be introduced into major update and so on. In this PR, just add docs and not to drop it and so on. Currently, we already provide this feature, so I add docs 👌

3358e38

nitrocode
nitrocode previously approved these changes Dec 17, 2022
@nitrocode nitrocode added the docs Documentation label Dec 17, 2022
@nitrocode
Copy link
Member

@krrrr38 also you can click the details link on the deploy/netlify pr check to see a deployment of your new docs. Idk if you knew that cause I see the attached screenshot.

https://deploy-preview-2808--runatlantis.netlify.app/docs/using-atlantis.html#using-atlantis

@nitrocode nitrocode dismissed their stale review December 17, 2022 16:41

more comments

@nitrocode nitrocode merged commit ab327a2 into runatlantis:main Dec 18, 2022
@nitrocode
Copy link
Member

Thank you @krrrr38 for improving the documentation!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants