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 #820

Closed
wants to merge 4 commits into from

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 document
  • I have run make install-tools and have attached any dependency changes to this pull request
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • If applicable, I have checked that any relevant tests pass after adding my changes
  • If applicable, I have updated any relevant documentation (README.md)
  • If applicable, I have tested my cross-platform changes on Ubuntu 22, Redhat 8, SUSE 15 and FreeBSD 13

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.
@github-actions github-actions bot added dependencies documentation Improvements or additions to documentation labels Sep 3, 2024
Copy link
Contributor

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-agent/820/

@ADubhlaoich ADubhlaoich changed the title Update Makefile and README Update documentation Makefile and README Sep 3, 2024
site/Makefile Outdated Show resolved Hide resolved
site/Makefile Outdated Show resolved Hide resolved
site/Makefile Outdated Show resolved Hide resolved
@dhurley dhurley added the v2.x Issues and Pull Requests related to the major version v2 label Sep 11, 2024
else
MARKDOWNLINT=docker run --rm -i -v ${CURDIR}:/src --workdir /src ${MARKDOWNLINT_IMG}
endif
endif
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this endif needed?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies documentation Improvements or additions to documentation v2.x Issues and Pull Requests related to the major version v2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants