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

[BUGFIX] Fix internal links to docs that may be rendered incorrectly #3915

Merged
merged 2 commits into from
Dec 29, 2021

Conversation

kenwade4
Copy link
Contributor

Please annotate your PR title to describe what the PR does, then give a brief bulleted description of your PR below. PR titles should begin with [BUGFIX], [FEATURE], [DOCS], or [MAINTENANCE]. If a new feature introduces breaking changes for the Great Expectations API or configuration files, please also add [BREAKING]. You can read about the tags in our contributor checklist.

Changes proposed in this pull request:

  • Absolute paths in markdown should have no file extension
  • Relative paths in markdown should have a file extension
  • Embedded HTML with absolute paths MUST use single quotes (href='...')

After submitting your PR, CI checks will run and @ge-cla-bot will check for your CLA signature.

For a PR with nontrivial changes, we review with both design-centric and code-centric lenses.

In a design review, we aim to ensure that the PR is consistent with our relationship to the open source community, with our software architecture and abstractions, and with our users' needs and expectations. That review often starts well before a PR, for example in github issues or slack, so please link to relevant conversations in notes below to help reviewers understand and approve your PR more quickly (e.g. closes #123).

Previous Design Review notes:

Definition of Done

Please delete options that are not relevant.

  • My code follows the Great Expectations style guide
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added unit tests where applicable and made sure that new and existing tests are passing.
  • I have run any local integration tests and made sure that nothing is broken.

Thank you for submitting!

- Absolute paths in markdown should have no file extension
- Relative paths in markdown should have a file extension
- Embedded HTML with absolute paths MUST use single quotes (href='...')
@github-actions
Copy link
Contributor

HOWDY! This is your friendly 🤖 CHANGELOG bot 🤖

Please don't forget to add a clear and succinct description of your change under the Develop header in docs_rtd/changelog.rst, if applicable. This will help us with the release process. See the Contribution checklist in the Great Expectations documentation for the type of labels to use!

Thank you!

@netlify
Copy link

netlify bot commented Dec 29, 2021

✔️ Deploy Preview for niobium-lead-7998 ready!

🔨 Explore the source changes: c270c03

🔍 Inspect the deploy log: https://app.netlify.com/sites/niobium-lead-7998/deploys/61cc8c75e898a10007769667

😎 Browse the preview: https://deploy-preview-3915--niobium-lead-7998.netlify.app

Copy link
Member

@cdkini cdkini left a comment

Choose a reason for hiding this comment

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

Never knew about relative/absolute paths working like that! Thanks so much for this 🙇🏽

Copy link
Member

@donaldheppner donaldheppner left a comment

Choose a reason for hiding this comment

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

we shouldn't have to make all these changes, something else must be the cause

@kyleaton
Copy link
Member

@cla-bot check

@donaldheppner donaldheppner enabled auto-merge (squash) December 29, 2021 16:28
@donaldheppner donaldheppner merged commit 68a25f4 into develop Dec 29, 2021
@donaldheppner donaldheppner deleted the bugfix/fix-internal-doc-links branch December 29, 2021 16:28
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