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.

Sign up for GitHub

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

Jump to bottom

ALEC-228: Create Quick Start section #97

Merged
merged 11 commits into from
Dec 9, 2022
Merged

ALEC-228: Create Quick Start section #97

merged 11 commits into from
Dec 9, 2022

Conversation

emarsh1995
Copy link
Contributor

  • Add quick-start/data-permissions.png, /engine-config.png, /situation-details.png, /situation-list.png, /situation-timeline.png
  • Add quick-start/engine-config.adoc, /introduction.adoc, /situations.adoc
  • Change engines/cluster.adoc -> engines/introduction.adoc & update
  • Change engines/dbscan.adoc -> engines/clustering.adoc & update
  • Update engines/deeplearning.adoc
  • Update ROOT/nav.adoc
  • Update about/welcome.adoc

External References

Emily Marsh added 7 commits November 30, 2022 16:42
ALEC-228: How to Use section
c7c5408 
- Add quick-start/data-permissions.png, /engine-config.png
- Add quick-start/engine.adoc, /introduction.adoc, /situations.adoc
ALEC-228: How to Use section
4e5ac8b 
- Update engines/cluster.adoc
- Update quick-start/engine.adoc
ALEC-228: How to Use section
e2379f9 
- Update engines/dbscan.adoc
ALEC-228: How to Use section
2b6e7a3 
- Update engines/cluster.adoc, /dbscan.adoc, /deeplearning.adoc
- Add quick-start/situation-details.png, /situation-list.png, /situation-timeline.png
- Update quick-start/engine.adoc, /situations.adoc
- Update ROOT/nav.adoc
ALEC-228: How to Use section
90e0cc5 
- Change engines/cluster.adoc -> engines/introduction.adoc
- Change engines/dbscan.adoc -> engines/clustering.adoc
- Change quick-start/engine.adoc -> quick-start/engine-config.adoc
- Update quick-start/situations.adoc
- Update ROOT/nav.adoc
Merge branch 'develop' into jira/alec-228
97e6a45
ALEC-228: How to Use section
546081a 
- Update about/welcome.adoc
- Update quick-start/situations.adoc
@emarsh1995 emarsh1995 added the docs label Dec 5, 2022
@emarsh1995 emarsh1995 self-assigned this Dec 5, 2022
Bonrob2
Bonrob2 suggested changes Dec 5, 2022
View reviewed changes
Copy link
Contributor

@Bonrob2 Bonrob2 left a comment

Choose a reason for hiding this comment

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

Some suggestions around restructuring it for better workflow. Thanks!

docs/modules/quick-start/pages/engine-config.adoc Outdated Show resolved Hide resolved
docs/modules/quick-start/pages/engine-config.adoc Outdated Show resolved Hide resolved
docs/modules/quick-start/pages/engine-config.adoc Outdated Show resolved Hide resolved
docs/modules/quick-start/pages/engine-config.adoc Outdated Show resolved Hide resolved
docs/modules/quick-start/pages/engine-config.adoc Outdated Show resolved Hide resolved
docs/modules/quick-start/pages/situations.adoc Outdated Show resolved Hide resolved
docs/modules/quick-start/pages/situations.adoc Outdated Show resolved Hide resolved
docs/modules/quick-start/pages/situations.adoc Show resolved Hide resolved
docs/modules/quick-start/pages/situations.adoc Outdated Show resolved Hide resolved
docs/modules/quick-start/pages/situations.adoc Outdated Show resolved Hide resolved
@Bonrob2
Copy link
Contributor

Bonrob2 commented Dec 5, 2022

We should update our doc outline to include these topics, or add them to the QS:

  • Move alarms to another situation
  • View unassociated alarms

@emarsh1995 emarsh1995 marked this pull request as draft December 5, 2022 19:59
Bonrob2
Bonrob2 suggested changes Dec 5, 2022
View reviewed changes
Copy link
Contributor

@Bonrob2 Bonrob2 left a comment

Choose a reason for hiding this comment

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

I seem to have missed a few files.

docs/modules/engines/pages/clustering.adoc Outdated Show resolved Hide resolved
docs/modules/engines/pages/clustering.adoc Outdated Show resolved Hide resolved
docs/modules/engines/pages/clustering.adoc Outdated Show resolved Hide resolved
docs/modules/engines/pages/clustering.adoc Outdated Show resolved Hide resolved
docs/modules/engines/pages/clustering.adoc Outdated Show resolved Hide resolved
docs/modules/engines/pages/introduction.adoc Outdated Show resolved Hide resolved
docs/modules/engines/pages/introduction.adoc Outdated Show resolved Hide resolved
docs/modules/engines/pages/introduction.adoc Outdated Show resolved Hide resolved
docs/modules/engines/pages/introduction.adoc Show resolved Hide resolved
docs/modules/engines/pages/introduction.adoc Outdated Show resolved Hide resolved
emarsh1995 and others added 2 commits December 5, 2022 18:31
@emarsh1995 @Bonrob2
Apply suggestions from code review
65e63c8 
Co-authored-by: Bonrob2 <59453630+Bonrob2@users.noreply.github.com>
ALEC-228: Quick Start section
5d45a8e 
- Update engines/clustering.adoc, /introduction.adoc
- Update quick-start/engine-config.adoc, /situations.adoc
@Bonrob2 Bonrob2 self-requested a review December 7, 2022 13:58
Bonrob2
Bonrob2 suggested changes Dec 7, 2022
View reviewed changes
Copy link
Contributor

@Bonrob2 Bonrob2 left a comment

Choose a reason for hiding this comment

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

Very nice work! The Quick Start flows very well. A few nits, and something we need to clarify regarding "unassociated alarms".

docs/modules/quick-start/pages/engine-config.adoc Outdated Show resolved Hide resolved
docs/modules/quick-start/pages/engine-config.adoc Outdated Show resolved Hide resolved
docs/modules/quick-start/pages/situations.adoc Outdated Show resolved Hide resolved
docs/modules/quick-start/pages/situations.adoc Outdated Show resolved Hide resolved
docs/modules/quick-start/pages/situations.adoc Outdated Show resolved Hide resolved
docs/modules/quick-start/pages/situations.adoc Outdated Show resolved Hide resolved
docs/modules/quick-start/pages/situations.adoc Outdated Show resolved Hide resolved
docs/modules/quick-start/pages/situations.adoc Show resolved Hide resolved
docs/modules/engines/pages/deeplearning.adoc Show resolved Hide resolved
docs/modules/quick-start/pages/situations.adoc Show resolved Hide resolved
emarsh1995 and others added 2 commits December 7, 2022 14:30
@emarsh1995 @Bonrob2
Apply suggestions from code review
eae2ce3 
Co-authored-by: Bonrob2 <59453630+Bonrob2@users.noreply.github.com>
ALEC-228: Quick Start guide
88a64a5 
- Update quick-start/situations.adoc
@emarsh1995 emarsh1995 marked this pull request as ready for review December 7, 2022 19:54
@github-actions github-actions bot requested a review from Bonrob2 December 7, 2022 19:55
GeraMantecon
GeraMantecon approved these changes Dec 9, 2022
View reviewed changes
Copy link

@GeraMantecon GeraMantecon left a comment

Choose a reason for hiding this comment

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

Looks good to me!

BenjaminJ
BenjaminJ approved these changes Dec 9, 2022
View reviewed changes
Copy link
Contributor

@BenjaminJ BenjaminJ left a comment

Choose a reason for hiding this comment

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

LGTM

Bonrob2
Bonrob2 approved these changes Dec 9, 2022
View reviewed changes
Copy link
Contributor

@Bonrob2 Bonrob2 left a comment

Choose a reason for hiding this comment

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

LGTM! Note that it would be better if the situation timeline graphic showed some activity, but let's capture that in a future Jira.

@emarsh1995 emarsh1995 merged commit 43ba69e into develop Dec 9, 2022
@emarsh1995 emarsh1995 deleted the jira/alec-228 branch December 9, 2022 17:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@BenjaminJ BenjaminJ BenjaminJ approved these changes

@GeraMantecon GeraMantecon GeraMantecon approved these changes

@Bonrob2 Bonrob2 Bonrob2 approved these changes

Assignees

@emarsh1995 emarsh1995

Labels
docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@emarsh1995 @Bonrob2 @BenjaminJ @GeraMantecon