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 two new config options for review handling #47

Merged
merged 4 commits into from
Aug 30, 2018
Merged

Conversation

timblair
Copy link
Member

  • default_owner_slack means you can set a single owner which applies to all pages without a specific owner_slack item in the frontmatter.
  • owner_slack_workspace allows customisation of the workspace to link to when an owner is present.

* `default_owner_slack` means you can set a single owner which applies
  to all pages without a specific `owner_slack` item in the frontmatter.
* `owner_slack_workspace` allows customisation of the workspace to link
  to when an owner is present.
Copy link

@tomnatt tomnatt left a comment

Choose a reason for hiding this comment

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

Docs requests, rather than anything wrong.

default_owner_slack: '#owner'
```

## `owner_slack_workspace`
Copy link

Choose a reason for hiding this comment

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

For clarity, can we have the docs the other way around - workspace followed by the channel entry?

@@ -156,3 +156,21 @@ Define a path to an Open API V3 spec file. This can be a relative file path or a
```yaml
api_path: ./source/pets.yml
```

## `default_owner_slack`
Copy link

Choose a reason for hiding this comment

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

Can you note that this (or the page override) is required if owner_slack_workspace is set? Also, can you add both of these config options to the example tech-docs.yml file.

Copy link

Choose a reason for hiding this comment

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

If I'm being picky, I'd say this variable name sounds like a reference to a workspace, not a channel / user.

Copy link
Member Author

Choose a reason for hiding this comment

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

The name is based on the existing frontmatter item called owner_slack. I don't really want to change that one too.

Copy link
Member Author

Choose a reason for hiding this comment

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

Can you note that this (or the page override) is required if owner_slack_workspace is set?

It's not: if neither is set then the owner just won't be linked.

@timblair timblair merged commit 60ee818 into master Aug 30, 2018
@timblair timblair deleted the default-owner branch August 30, 2018 08:51
@timblair timblair mentioned this pull request Sep 4, 2018
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.

2 participants