Skip to content
This repository has been archived by the owner on Jul 3, 2023. It is now read-only.

modified hardcoded links in docs #309

Merged
merged 3 commits into from
Feb 15, 2023

Conversation

CharityKithaka
Copy link
Contributor

[Modified hardcoded links to follow the rSt way of writing.]

Changes

Changed all links in all the docs.

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)
  • 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.

@CharityKithaka
Copy link
Contributor Author

Hey @skrawcz the changes.

Copy link
Collaborator

@skrawcz skrawcz left a comment

Choose a reason for hiding this comment

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

Thanks for the touch ups! But a couple of things to fix up please.

  1. Removing the vscode file.
  2. There was a paragraph that I think you by accident deleted some words from.
  3. The reST guide has a trailing slash i.e. / in its example. We don't actually need that trailing slash / for our links. Could you remove it for the links that you added it to please?
    e.g. <https://medium.com/avmconsulting-blog/running-a-python-application-on-kubernetes-aws-56609e7cd88c/>_ should just be <https://medium.com/avmconsulting-blog/running-a-python-application-on-kubernetes-aws-56609e7cd88c>_

.vscode/settings.json Outdated Show resolved Hide resolved
docs/extensions.rst Outdated Show resolved Hide resolved
docs/hamilton-community.rst Outdated Show resolved Hide resolved
docs/hamilton-community.rst Outdated Show resolved Hide resolved
@skrawcz skrawcz linked an issue Feb 14, 2023 that may be closed by this pull request
@CharityKithaka
Copy link
Contributor Author

hey @skrawcz worked on the changes.

@skrawcz
Copy link
Collaborator

skrawcz commented Feb 15, 2023

@CharityKithaka the pre-commit check is failing. Could you:

  1. install pre-commit. pre-commit install
  2. run it -- pre-commit run --all-files -- it should fix the two files that are failing.
  3. commit the changes.
    If you need help see https://github.com/stitchfix/hamilton/blob/main/developer_setup.md#set-up-your-local-dev-environment and https://pre-commit.com/

@CharityKithaka
Copy link
Contributor Author

Hey @skrawcz everything is in order now.

Copy link
Collaborator

@skrawcz skrawcz left a comment

Choose a reason for hiding this comment

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

Thanks @CharityKithaka! I will merge this now. Sorry I have been a little swamped this week; I will try to get you another task tomorrow/the day after.

@skrawcz skrawcz merged commit f0ffb4c into stitchfix:main Feb 15, 2023
CharityKithaka added a commit to CharityKithaka/hamilton that referenced this pull request Feb 15, 2023
@CharityKithaka
Copy link
Contributor Author

CharityKithaka commented Feb 15, 2023

Hey, @skrawcz that would be great. I will genuinely appreciate it. I might have tried to revert the PR by mistake my apologies for that.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

how to not hardcode links
2 participants