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

[DOC FIX] Updating 1.1.2 Documentation with the required fixes #13006

Merged
merged 1 commit into from
Aug 25, 2023

Conversation

dhruvinmaniar123
Copy link
Contributor

Fixing the Doc of 1.1.2 with the required changes

Type of change:

  • Bug fix
  • Improvement
  • New feature
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation

Checklist:

  • I have read the CONTRIBUTING document.
  • My PR title is Fixes <issue-number>: <short explanation>
  • I have commented on my code, particularly in hard-to-understand areas.
  • For JSON Schema changes: I updated the migration scripts or explained why it is not needed.

@dhruvinmaniar123 dhruvinmaniar123 self-assigned this Aug 25, 2023
@dhruvinmaniar123 dhruvinmaniar123 temporarily deployed to test August 25, 2023 14:05 — with GitHub Actions Inactive
@dhruvinmaniar123 dhruvinmaniar123 temporarily deployed to test August 25, 2023 14:05 — with GitHub Actions Inactive
@dhruvinmaniar123 dhruvinmaniar123 temporarily deployed to test August 25, 2023 14:05 — with GitHub Actions Inactive
@dhruvinmaniar123 dhruvinmaniar123 temporarily deployed to test August 25, 2023 14:05 — with GitHub Actions Inactive
@dhruvinmaniar123 dhruvinmaniar123 temporarily deployed to test August 25, 2023 14:05 — with GitHub Actions Inactive
@dhruvinmaniar123 dhruvinmaniar123 temporarily deployed to test August 25, 2023 14:05 — with GitHub Actions Inactive
@github-actions github-actions bot added documentation Improvements or additions to documentation devops safe to test Add this label to run secure Github workflows on PRs labels Aug 25, 2023
@dhruvinmaniar123 dhruvinmaniar123 merged commit fa67ce0 into main Aug 25, 2023
@dhruvinmaniar123 dhruvinmaniar123 deleted the fix-docs-1.1.2 branch August 25, 2023 14:12
Comment on lines +124 to +154
3. Web Configuration:

```
web:
uriPath: ${WEB_CONF_URI_PATH:-"/api"}
hsts:
enabled: ${WEB_CONF_HSTS_ENABLED:-false}
maxAge: ${WEB_CONF_HSTS_MAX_AGE:-"365 days"}
includeSubDomains: ${WEB_CONF_HSTS_INCLUDE_SUBDOMAINS:-"true"}
preload: ${WEB_CONF_HSTS_PRELOAD:-"true"}
frame-options:
enabled: ${WEB_CONF_FRAME_OPTION_ENABLED:-false}
option: ${WEB_CONF_FRAME_OPTION:-"SAMEORIGIN"}
origin: ${WEB_CONF_FRAME_ORIGIN:-""}
content-type-options:
enabled: ${WEB_CONF_CONTENT_TYPE_OPTIONS_ENABLED:-false}
xss-protection:
enabled: ${WEB_CONF_XSS_PROTECTION_ENABLED:-false}
on: ${WEB_CONF_XSS_PROTECTION_ON:-true}
block: ${WEB_CONF_XSS_PROTECTION_BLOCK:-true}
csp:
enabled: ${WEB_CONF_XSS_CSP_ENABLED:-false}
policy: ${WEB_CONF_XSS_CSP_POLICY:-"default-src 'self'"}
reportOnlyPolicy: ${WEB_CONF_XSS_CSP_REPORT_ONLY_POLICY:-""}
referrer-policy:
enabled: ${WEB_CONF_REFERRER_POLICY_ENABLED:-false}
option: ${WEB_CONF_REFERRER_POLICY_OPTION:-"SAME_ORIGIN"}
permission-policy:
enabled: ${WEB_CONF_PERMISSION_POLICY_ENABLED:-false}
option: ${WEB_CONF_PERMISSION_POLICY_OPTION:-""}
```
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is this a breaking change @mohityadav766 ?

Copy link
Collaborator

Choose a reason for hiding this comment

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

if it's not added the server won't start. We need to update the docs generally to specify that people should use the latest openmetadata.yaml file. We might even want to publish that as part of the release bits if necessary

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
devops documentation Improvements or additions to documentation safe to test Add this label to run secure Github workflows on PRs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants