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

Publish documentation to github pages #5

Closed
d-ryan-ashcraft opened this issue Apr 28, 2024 · 0 comments
Closed

Publish documentation to github pages #5

d-ryan-ashcraft opened this issue Apr 28, 2024 · 0 comments
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@d-ryan-ashcraft
Copy link
Collaborator

d-ryan-ashcraft commented Apr 28, 2024

As we migrate to the new public repo, we need to update our documentation needs to be brought into the repository and to have a new job that will publish it. Some of the prior docs had some complex subfolders with multiple aissemble references. If possible, it would be nice to clean that up in the process of working this ticket.

Since we publish some schemas for data lineage via github pages, we'll also need to ensure those resolve in a way that matches the codebase for 1.7.0.

Definition of Done

  • Migrate over existing documentation into codebase (split into tranches below)
  • ✅ Leverage GitHub Action to publish to GitHub pages
  • ✅ Add Badge for documentation to the top of the page (with other useful, common badges)
  • ✅ Update main readme file to remove link placeholders and fill in documentation section with more topical information

Documentation Tranches

Tranche 1

Tranche 2

Tranche 3

Tranche 4

Tranche 5

Tranche 6

Tranche 7

@d-ryan-ashcraft d-ryan-ashcraft added the enhancement New feature or request label Apr 28, 2024
@d-ryan-ashcraft d-ryan-ashcraft added this to the 1.7.0 milestone Apr 28, 2024
@d-ryan-ashcraft d-ryan-ashcraft self-assigned this Apr 29, 2024
d-ryan-ashcraft added a commit that referenced this issue Apr 30, 2024
#5 📝 some initial documentation tweaks
d-ryan-ashcraft added a commit that referenced this issue Apr 30, 2024
#5 📝 GitHub Pages setup and tranche 1 of docs
d-ryan-ashcraft added a commit that referenced this issue Apr 30, 2024
d-ryan-ashcraft added a commit that referenced this issue May 1, 2024
d-ryan-ashcraft added a commit that referenced this issue May 1, 2024
d-ryan-ashcraft added a commit that referenced this issue May 2, 2024
aaron-gary added a commit that referenced this issue May 2, 2024
# This is the 1st commit message:

# This is a combination of 4 commits.
# This is the 1st commit message:

#2 Add Maven build workflow

# This is the commit message #2:

#2 update build workflow

# This is the commit message #3:

#2 add branch checkout to build workflow

# This is the commit message #4:

#2 Add on event to build workflow

# This is the commit message #2:

#2 Remove unused executions

# This is the commit message #3:

#2 Focus on build

# This is the commit message #4:

#2 Remove build execution where not needed

# This is the commit message #5:

#2 debug failing module

# This is the commit message #6:

#2 Remove unused target folder copy

# This is the commit message #7:

#2 Build spark and jenkins docker images

# This is the commit message #8:

#2 Retry full build

# This is the commit message #9:

#2 Omitting module

# This is the commit message #10:

#2 Fix for out of disk space

# This is the commit message #11:

#2 tagging docker images

# This is the commit message #12:

#2 Remove Temporarily remove Docker module

# This is the commit message #13:

#2 Build update

# This is the commit message #14:

#2 Build update

# This is the commit message #15:

#2 move chart dry-runs to IT profile

# This is the commit message #16:

#2 curl delta-hive assembly in docker build

# This is the commit message #17:

#2 cache m2 repo

# This is the commit message #18:

#2 prune docker build cache between images to save space

# This is the commit message #19:

#2 add maven build-cache to GH cache

# This is the commit message #20:

#2 run clean goal in build to clear docker cache

# This is the commit message #21:

#2 set maven caches to always save even if the build failed

# This is the commit message #22:

#2 adjust number of docker modules built

# This is the commit message #23:

#2 use the same cache for .m2 even if poms change

# This is the commit message #24:

#2 change from `save-always` flag to `if: always()` see actions/cache#1315

# This is the commit message #25:

#2 further reduce docker images being built

# This is the commit message #26:

#2 disable modules that depend on helm charts

# This is the commit message #27:

#2 use maven wrapper

# This is the commit message #28:

#2 restore modules to test build-cache

# This is the commit message #29:

#2 fix build of modules with intra-project chart dependencies

# This is the commit message #30:

#2 use explict .m2 repo cache so we can fall-back to older caches

# This is the commit message #31:

#2 save maven caches on build failure
aaron-gary added a commit that referenced this issue May 2, 2024
# This is the 1st commit message:

# This is a combination of 4 commits.
# This is the 1st commit message:

#2 Add Maven build workflow

# This is the commit message #2:

#2 update build workflow

# This is the commit message #3:

#2 add branch checkout to build workflow

# This is the commit message #4:

#2 Add on event to build workflow

# This is the commit message #2:

#2 Remove unused executions

# This is the commit message #3:

#2 Focus on build

# This is the commit message #4:

#2 Remove build execution where not needed

# This is the commit message #5:

#2 debug failing module

# This is the commit message #6:

#2 Remove unused target folder copy

# This is the commit message #7:

#2 Build spark and jenkins docker images

# This is the commit message #8:

#2 Retry full build

# This is the commit message #9:

#2 Omitting module

# This is the commit message #10:

#2 Fix for out of disk space

# This is the commit message #11:

#2 tagging docker images

# This is the commit message #12:

#2 Remove Temporarily remove Docker module

# This is the commit message #13:

#2 Build update

# This is the commit message #14:

#2 Build update

# This is the commit message #15:

#2 move chart dry-runs to IT profile

# This is the commit message #16:

#2 curl delta-hive assembly in docker build

# This is the commit message #17:

#2 cache m2 repo

# This is the commit message #18:

#2 prune docker build cache between images to save space

# This is the commit message #19:

#2 add maven build-cache to GH cache

# This is the commit message #20:

#2 run clean goal in build to clear docker cache

# This is the commit message #21:

#2 set maven caches to always save even if the build failed

# This is the commit message #22:

#2 adjust number of docker modules built

# This is the commit message #23:

#2 use the same cache for .m2 even if poms change

# This is the commit message #24:

#2 change from `save-always` flag to `if: always()` see actions/cache#1315

# This is the commit message #25:

#2 further reduce docker images being built

# This is the commit message #26:

#2 disable modules that depend on helm charts

# This is the commit message #27:

#2 use maven wrapper

# This is the commit message #28:

#2 restore modules to test build-cache

# This is the commit message #29:

#2 fix build of modules with intra-project chart dependencies

# This is the commit message #30:

#2 use explict .m2 repo cache so we can fall-back to older caches

# This is the commit message #31:

#2 save maven caches on build failure
d-ryan-ashcraft added a commit that referenced this issue May 3, 2024
#5 📝 Tranche 7 of documentation migration
d-ryan-ashcraft added a commit that referenced this issue May 3, 2024
#5 🔧 fix branch reference causing failing publish job
aaron-gary added a commit that referenced this issue May 28, 2024
# This is the 1st commit message:

#2 build script for runner

# This is the commit message #2:

#2 add architecture to action workflow

# This is the commit message #3:

#2 Update python version

# This is the commit message #4:

#2 remove python install from workflow

# This is the commit message #5:

#2 update Docker install

# This is the commit message #6:

#2 update docker install

# This is the commit message #7:

#2 update remove docker install from workflow script

# This is the commit message #8:

#2 update remove helm install

# This is the commit message #9:

#2 update get docker info
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant