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

Make j1-integration document output ordered #321

Closed
ndowmon opened this issue Aug 28, 2020 · 1 comment
Closed

Make j1-integration document output ordered #321

ndowmon opened this issue Aug 28, 2020 · 1 comment
Assignees
@austinkelleher
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@ndowmon
Copy link
Contributor

ndowmon commented Aug 28, 2020

The order of documentation that's generated from the j1-integration document command seems to be based on the dependency tree of steps. Changes to the dependency tree cause git diffs that don't clearly show what if anything changed.

Documentation could be ordered alphabetically to suppress this behavior.

Might be good to fix alongside #309 and #316
@aiwilliams aiwilliams added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Aug 28, 2020
@austinkelleher
Copy link
Contributor

Ordering alphabetically makes sense to me. I originally thought it would be nice to have the docs actually show the ingestion order (may be useful to developers), but definitely advantages to the alphabetical ordering. Especially useful for diffing.

@austinkelleher austinkelleher self-assigned this Aug 30, 2020
austinkelleher added a commit that referenced this issue Sep 1, 2020
@austinkelleher
Merge pull request #324 from JupiterOne/321-alphabetical-document
66c6e7e 
Fixes #321 - j1-integration document output in alphabetical order by …
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@austinkelleher austinkelleher

Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@aiwilliams @austinkelleher @ndowmon