Skip to content

Conversation

skrawcz
Copy link
Contributor

@skrawcz skrawcz commented Jun 9, 2025

This replaces all links with the right ones.

Changes

  • changes most repo links to the correct one
  • Updates most Hamilton -> Apache Hamilton

How I tested this

  • inspected

Notes

  • This does not replace the hamilton.dagworks.io links until we have hamilton.apache.org set up and running.

Checklist

  • PR has an informative and human-readable title (this will be pulled into the release notes)
  • Changes are limited to a single goal (no scope creep)
  • Code passed the pre-commit check & code is left cleaner/nicer than when first encountered.
  • Any change in functionality is tested
  • New functions are documented (with a description, list of inputs, and expected output)
  • Placeholder code is flagged / future TODOs are captured in comments
  • Project documentation has been updated if adding/changing functionality.

@skrawcz skrawcz requested review from jernejfrank and zilto June 9, 2025 03:39
@skrawcz skrawcz changed the title Replaces most old repository links to point to new repo Replaces most links and Hamilton references Jun 9, 2025
@skrawcz skrawcz force-pushed the update_references branch 9 times, most recently from c1e7948 to 4312df5 Compare June 14, 2025 14:17
@skrawcz skrawcz force-pushed the update_references branch 9 times, most recently from e87eba8 to b256e29 Compare June 16, 2025 03:45
@skrawcz skrawcz requested a review from pjfanning June 16, 2025 03:45
@skrawcz skrawcz force-pushed the update_references branch from b256e29 to d4d31cc Compare June 17, 2025 17:27
Stefan Krawczyk and others added 3 commits June 20, 2025 22:34
This does not replace the hamilton.dagworks.io links
until we have hamilton.apache.org set up and running.
This does a few things:

1. Adds .github workflow to build things
2. Adds .asf.yaml that specifies that a site should be built and deployed.

No real design decisions, other than this seems to work and is low effort.

Squashed commits below:

Adds to asf.yaml and attempts to write to docs to branch (+4 squashed commits)
Squashed commits:
[e44ca55] Adds incubating reference
[486c57f] Adds pushing to asf-* branches

Will see if this works.
[4312df5] Fixes docs and creates PDF
[919ccc2] Adds github workflow to build docs

WIP commit.
skrawcz added 2 commits June 20, 2025 22:34
This change updates links to the right documentation domain.
skrawcz added 3 commits June 20, 2025 22:50
Was getting a too shallow warning. Gemini suggested
increasing the fetch depth - so I set it to 0 to check
out the whole repo.
@skrawcz skrawcz force-pushed the update_references branch 2 times, most recently from 7145b05 to 242cf8d Compare June 21, 2025 06:34
@skrawcz skrawcz force-pushed the update_references branch from 242cf8d to 5d8fd01 Compare June 21, 2025 06:42
@skrawcz
Copy link
Contributor Author

skrawcz commented Jun 21, 2025

@apache/hamilton-committers I think the docs are in a reasonable state to commit. There's more work to get the apache things we need in, but I've done a lot of changes here that I think are good enough to commit.

I'd squash merge this PR with a nice commit upon approval.

@skrawcz
Copy link
Contributor Author

skrawcz commented Jun 21, 2025

note: the unit tests are failing due to some kedro library change...

@skrawcz skrawcz requested a review from elijahbenizzy June 21, 2025 16:43
Copy link
Contributor

@elijahbenizzy elijahbenizzy left a comment

Choose a reason for hiding this comment

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

Should we use Hamilton or Apache Hamilton when referring to the core features? I.E. the library's name isn't changing -- it's still a "Hamilton Node" not an "Apache HAmilton Node"? Otherwise looks good.

Copy link
Contributor

@jernejfrank jernejfrank left a comment

Choose a reason for hiding this comment

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

Just a minor comment/question on the domain from my side since I saw that some files already use https://hamilton.apache.org/

I missed these domain changes. Note the docs don't have
en/latest/ on them.
Since in most cases Hamilton suffices when describing concepts within
Hamilton.
@skrawcz skrawcz force-pushed the update_references branch from 0af0934 to a319142 Compare June 23, 2025 04:04
@skrawcz
Copy link
Contributor Author

skrawcz commented Jun 23, 2025

@elijahbenizzy @jernejfrank I think I addressed your concerns.

@elijahbenizzy
Copy link
Contributor

@skrawcz guidance on naming:

You don't need to use Apache Hamilton everywhere. It's good to start
with Apache Hamilton and in some cases even Apache Hamilton
(incubating).
It is ok to shorten to Hamilton later in the doc. I would generally
use Apache Hamilton in headings but inside paragraphs, it may be
better to use Hamilton - although first reference in the paragraph -
might be best to stick with Apache Hamilton.

@skrawcz
Copy link
Contributor Author

skrawcz commented Jun 23, 2025

@skrawcz guidance on naming:

You don't need to use Apache Hamilton everywhere. It's good to start
with Apache Hamilton and in some cases even Apache Hamilton
(incubating).
It is ok to shorten to Hamilton later in the doc. I would generally
use Apache Hamilton in headings but inside paragraphs, it may be
better to use Hamilton - although first reference in the paragraph -
might be best to stick with Apache Hamilton.

Yes. I'm not going to go through the docs with a fine toothed comb here. I err'ed on the side of too much Apache Hamilton. Which I think is fine. We can always adjust this as we touch and read the docs...

@jernejfrank
Copy link
Contributor

LGTM, I will let @elijahbenizzy approve

@skrawcz skrawcz merged commit 1049b8c into main Jun 24, 2025
5 of 10 checks passed
@skrawcz skrawcz deleted the update_references branch June 24, 2025 05:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants