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

"do not document" on status codes 502 + 504 #822

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

ePaul
Copy link
Member

@ePaul ePaul commented Jan 7, 2025

This was missed before, noticed in #821.

Also, fix the indentation of the text for 502, and remove a duplicated section in the building instructions.

ePaul added 2 commits January 7, 2025 14:34
This was missed before.
Also, fix the indentation of the text for 504.
Copy link

invalid team ID

The team ID in your .zappr.yaml file does not appear to be valid. Please, fix
this before team ID checks will be added back into ComPR's specification check.

You can follow this guideline for help.

@ePaul ePaul added minor Minor changes, e.g. low risk config updates, changes that do not introduce a new API call. guideline-change labels Jan 7, 2025
@ePaul
Copy link
Member Author

ePaul commented Jan 7, 2025

👍

Comment on lines -50 to -59
== Watch for changes and rebuild

[source,bash]
----
make watch
----

It uses https://github.com/watchexec/watchexec[watchexec] to watch for
changes in the `.adoc` (and `.css`) files to rebuild the html on save.

Copy link
Member Author

Choose a reason for hiding this comment

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

This somehow got duplicated – it's also in lines 30 to 39 above.

@@ -398,8 +398,8 @@ May be documented on endpoints that are planned to be implemented in the
future to indicate that they are still not available.

[[status-code-502]]
==== 502 Bad Gateway {rfc-status-502} {ALL}
[.indent]is meaningless
Copy link
Member Author

Choose a reason for hiding this comment

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

I suppose this was a copy+paste failure (or typing in the wrong window).

Copy link
Member

@SmilyOrg SmilyOrg 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 cleaning after me! 😅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement guideline-change minor Minor changes, e.g. low risk config updates, changes that do not introduce a new API call.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants