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

Add simple meta-documentation to Makefile and README.md #1388

Merged

Conversation

danudey
Copy link
Collaborator

@danudey danudey commented Mar 26, 2024

Add documentation for Makefile to Makefile; add documentation for operator reference updates to README.md

Product Version(s): N/A

Issue: N/A

Link to docs preview: N/A

SME review:

  • An SME has approved this change.

DOCS review:

  • A member of the docs team has approved this change.

Additional information:

This PR adds two sets of documentation; one, a large comment block at the top of Makefile,
includes a list of the most interesting/relevant Makefile targets for docs building and
for udpating the Operator reference for docs. The second is a small list of the most
interesting targets for updating the Operator reference, and how to use them.

Merge checklist:

  • Deploy preview inspected wherever changes were made
  • Build completed successfully
  • Test have passed

@danudey danudey requested a review from a team as a code owner March 26, 2024 21:02
@danudey danudey added enhancement New feature or request Needs docs review labels Mar 26, 2024
@danudey danudey self-assigned this Mar 26, 2024
Copy link

netlify bot commented Mar 26, 2024

Deploy Preview succeeded!

Built without sensitive environment variables

Name Link
🔨 Latest commit 22a06f6
🔍 Latest deploy log https://app.netlify.com/sites/tigera/deploys/66033907efe2950008ff3d14
😎 Deploy Preview https://deploy-preview-1388--tigera.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 47 (🔴 down 25 from production)
Accessibility: 93 (no change from production)
Best Practices: 83 (no change from production)
SEO: 86 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

netlify bot commented Mar 26, 2024

Deploy Preview for calico-docs-preview-next ready!

Name Link
🔨 Latest commit 22a06f6
🔍 Latest deploy log https://app.netlify.com/sites/calico-docs-preview-next/deploys/66033907aa8f440008f1fafd
😎 Deploy Preview https://deploy-preview-1388--calico-docs-preview-next.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 67 (🟢 up 4 from production)
Accessibility: 93 (no change from production)
Best Practices: 92 (no change from production)
SEO: 79 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

@ctauchen
Copy link
Collaborator

LGTM, thanks. Feel free to merge.

@ctauchen ctauchen merged commit 35ea273 into tigera:main Mar 27, 2024
9 of 10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request Needs docs review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants