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 documentation for Maintenance Mode and Health Checks in Front-Commerce #917

Merged
merged 1 commit into from
Jun 21, 2024

Conversation

paul-vd
Copy link
Member

@paul-vd paul-vd commented Jun 19, 2024

The changes introduce comprehensive documentation for the Maintenance Mode and Health Checks features in Front-Commerce. This includes:

  1. A new section on Global Services, explaining their lifecycle and providing references to the RateLimiter and MaintenanceMode services.
  2. Detailed guides on how to automatically detect service health and place the site in maintenance mode, including how to add health checks and configure their intervals.
  3. Instructions on how to manually enter and exit maintenance mode using the Maintenance Mode API, including setting up authorization tokens and bypassing maintenance mode for specific IP addresses.
  4. Updates to the defineExtension API reference to include new lifecycle hooks onServerInit and onServerServicesInit.
  5. Configuration options for customizing the Maintenance Mode service in the front-commerce.config.ts file.
  6. A new category in the documentation specifically for Maintenance Mode, making it easier for users to find relevant information.

Copy link

linear bot commented Jun 19, 2024

Copy link

netlify bot commented Jun 19, 2024

👷 Deploy Preview for heuristic-almeida-1a1f35 processing.

Name Link
🔨 Latest commit c2947de
🔍 Latest deploy log https://app.netlify.com/sites/heuristic-almeida-1a1f35/deploys/66759878850bb00008d7d039

@paul-vd paul-vd force-pushed the fc-2251-document-maintenance-service branch from 14391b5 to 10063ff Compare June 20, 2024 05:52
@paul-vd paul-vd force-pushed the fc-2251-document-maintenance-service branch from 10063ff to 598bc95 Compare June 20, 2024 13:02
Copy link
Member

@real34 real34 left a comment

Choose a reason for hiding this comment

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

Nice docs!
Thanks.

Unless you want me to, I don't think it's necessary to do another review from me (hence the approval).

@paul-vd paul-vd force-pushed the fc-2251-document-maintenance-service branch from 598bc95 to c2947de Compare June 21, 2024 15:12
@paul-vd paul-vd merged commit ffef67b into next Jun 21, 2024
4 checks passed
@paul-vd paul-vd deleted the fc-2251-document-maintenance-service branch June 21, 2024 15:27
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.

None yet

3 participants