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

Add guide for altis-cli #536

Open
9 of 23 tasks
rmccue opened this issue Aug 16, 2023 · 3 comments
Open
9 of 23 tasks

Add guide for altis-cli #536

rmccue opened this issue Aug 16, 2023 · 3 comments
Assignees
Labels
developer advocacy Developer Advocacy related tasks should have Should be done, medium priority for now
Milestone

Comments

@rmccue
Copy link
Member

rmccue commented Aug 16, 2023

We should add an altis-cli guide explaining how to use the altis-cli - also that it exists!

@wisyhambolu had some great ideas here as well around including screenshots and GIFs to help people understand general use cases.

  • Show off features
  • example tasks with screenshots and gifs/ascii-cinema
  • expose the value of altis-cli

Acceptance Criteria

  • All existing features must be covered
  • Examples should be included where it makes sense
  • If gif or ascii-cinema movies where appropriate
  • Documentation should reside in Altis-documentation/other-docs
  • Should meet the MarkDown standards
  • Backport docs to the original release

For Altis Team Use

Ready for Work Checklist

Is this ticket ready to be worked on? See
the Play Book Definition of Ready

  • Is the title clear?
  • Is the description clear and detailed enough?
  • Are acceptance criteria listed?
  • Have any dependencies been identified? (Optional)
  • Have any documentation/playbook changes been identified? (Optional)
  • Is an estimate or time box assigned?
  • Is a priority label assigned?
  • Is this ticket added to a milestone?
  • Is this ticket added to an epic? (Optional)

Completion Checklist

Is this ticket done? See
the Play Book Definition of Done

  • Has the acceptance criteria been met?
  • Is the documentation updated (including README)?
  • Do any code/documentation changes meet project standards?
  • Are automatic tests in place to verify the fix or new functionality?
    • Or are manual tests documented (at least on this ticket)?
  • Are any Playbook/Handbook pages updated?
  • Has a new module release (patch/minor) been created/scheduled?
  • Have the appropriate backport labels been added to the PR?
@mikelittle mikelittle added to refine Issues needing refinement. should have Should be done, medium priority for now labels May 29, 2024
@mikelittle mikelittle added this to the Altis v20 milestone May 29, 2024
@mikelittle
Copy link
Contributor

Hey team! Please add your planning poker estimate with Zenhub @ferschubert-hm @jerico @wisyhambolu

@mikelittle mikelittle removed the to refine Issues needing refinement. label May 29, 2024
@missjwo missjwo added the developer advocacy Developer Advocacy related tasks label Dec 10, 2024
@rmccue
Copy link
Member Author

rmccue commented Jan 27, 2025

Is this the same issue as humanmade/altis-cli#3 ?

@mikelittle
Copy link
Contributor

I've made some progress on this, trying out some of the commands and capturing output to add to the documentation. Mucho props to @jerico for his notes on the original v1 release ticket. Very helpful. 👍
I ran into a couple of issues: there are several deprecated dependencies, and one of them output to the screen for every command.
I also couldn't get the deploy command to show up on the Altis dashboard. Though it looks like it is going through the motions.
I decided to make a simple change to the repo and try to push that. However, because auto-deploy is on, it started the deployment anyway. But that failed. I'm currently investigating why it failed.

Nothing other than local notes so far so. No commits.
I'm away for a couple of days, so I'll pop this back into the sprint backlog. Though I expect to pick it up again on Tuesday.

mikelittle added a commit to humanmade/altis-cloud that referenced this issue Feb 10, 2025
This add documentation for the Altis CLI tool. There are a couple of screenshots too.

This addresses humanmade/altis-documentation#536
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
developer advocacy Developer Advocacy related tasks should have Should be done, medium priority for now
Projects
None yet
Development

No branches or pull requests

3 participants