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

docs: Replace ampersand #749

Merged
merged 2 commits into from Oct 8, 2020
Merged

docs: Replace ampersand #749

merged 2 commits into from Oct 8, 2020

Conversation

kevgo
Copy link
Contributor

@kevgo kevgo commented Oct 6, 2020

Proposed changes

Replace & with and since "identity and access proxy" reads better than "identity & access proxy" to me. This is an extract from #567, it makes sense to discuss this separately. Not feeling strongly about this. If the & is part of the branding we can leave it in.

Checklist

  • I have read the contributing guidelines.
  • I have read the security policy.
  • I confirm that this pull request does not address a security
    vulnerability. If this pull request addresses a security. vulnerability, I
    confirm that I got green light (please contact
    security@ory.sh) from the maintainers to push
    the changes.
  • I have added tests that prove my fix is effective or that my feature
    works.
  • I have added or changed the documentation.

@kevgo kevgo changed the title Replace ampersand docs: Replace ampersand Oct 6, 2020
@kevgo
Copy link
Contributor Author

kevgo commented Oct 7, 2020

Another reason for this change is that the old format leads to anchors containing double-dashes like
ory-oathkeeper-identity--access-proxy

Copy link
Member

@aeneasr aeneasr left a comment

Choose a reason for hiding this comment

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

Could you please address the merge conflicts? :)

@aeneasr
Copy link
Member

aeneasr commented Oct 7, 2020

Also keep in mind that we're using doctoc to generate the ToC - not sure if that was what generated the output! Also not sure if this is currently automated...

@zepatrik
Copy link
Member

zepatrik commented Oct 7, 2020

Pretty sure it's not automated....

@kevgo
Copy link
Contributor Author

kevgo commented Oct 7, 2020

Merge conflicts resolved.

I was asking about doctoc automation in #748. Happy to look into automating it. Can we assume a Bash environment, i.e. find and xargs, or does this automation need to run on Windows as well?

@aeneasr
Copy link
Member

aeneasr commented Oct 8, 2020

Ah sorry, I must have overlooked that. Yeah - this would run on a ubuntu instance. I think it would make sense to have doctoc execution as part of maybe the docs/build pipeline. @zepatrik what you think?

@aeneasr aeneasr merged commit 8337b80 into ory:master Oct 8, 2020
aeneasr pushed a commit that referenced this pull request Oct 9, 2020
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