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

Update documentation Makefile and README #6339

Merged
merged 6 commits into from
Sep 4, 2024
Merged

Conversation

ADubhlaoich
Copy link
Contributor

Proposed changes

This commit updates the documentation Makefile and README, reflecting changes to it across NGINX's open source repositories for consistency. It removes unnecessary targets: Netlify is no longer used, nor was the Makefile used for Netlify for quite some time.

The guidance for Makefile targets in the README is updated accordingly, as well formatting instructions for how we use Hugo contemporaneously.

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

This commit updates the documentation Makefile and README, reflecting
changes to it across NGINX's open source repositories for consistency.
It removes unnecessary targets: Netlify is no longer used, nor was the
Makefile used for Netlify for quite some time.

The guidance for Makefile targets in the README is updated accordingly,
as well formatting instructions for how we use Hugo contemporaneously.
@ADubhlaoich ADubhlaoich added documentation Pull requests/issues for documentation needs cherry pick Cherry pick this PR into a release branch labels Sep 3, 2024
@ADubhlaoich ADubhlaoich self-assigned this Sep 3, 2024
@ADubhlaoich ADubhlaoich requested review from a team as code owners September 3, 2024 16:03
Copy link

github-actions bot commented Sep 3, 2024

Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/nginx-ingress-controller/6339/

docs/Makefile Outdated Show resolved Hide resolved
docs/Makefile Outdated Show resolved Hide resolved
Copy link

@j1m-ryan j1m-ryan left a comment

Choose a reason for hiding this comment

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

Approved, noting Paul's comment

docs/Makefile Outdated Show resolved Hide resolved
docs/Makefile Outdated Show resolved Hide resolved
docs/Makefile Outdated Show resolved Hide resolved
@ADubhlaoich ADubhlaoich merged commit f1d8dc0 into main Sep 4, 2024
30 checks passed
@ADubhlaoich ADubhlaoich deleted the update-makefile-readme branch September 4, 2024 09:18
nginx-bot pushed a commit that referenced this pull request Sep 4, 2024
This commit updates the documentation Makefile and README, reflecting
changes to it across NGINX's open source repositories for consistency.
It removes unnecessary targets: Netlify is no longer used, nor was the
Makefile used for Netlify for quite some time.

The guidance for Makefile targets in the README is updated accordingly,
as well formatting instructions for how we use Hugo contemporaneously.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Pull requests/issues for documentation needs cherry pick Cherry pick this PR into a release branch
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants