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

Remove conjurize from README #100

Merged
merged 4 commits into from Jul 8, 2020
Merged

Remove conjurize from README #100

merged 4 commits into from Jul 8, 2020

Conversation

izgeri
Copy link
Contributor

@izgeri izgeri commented Jul 7, 2020

What does this PR do?

  • Removes "conjurize" reference from README, since this is only relevant for Conjur Enterprise v4
  • Moves Windows section to under "host with API key", since that is what's documented there
  • Reorganizes the CONTRIBUTING guide, and adds a sequence diagram
  • Minor additional cleanup (TOC, clarifying language, adding links)

What ticket does this PR close?

Connected to #97

Checklists

Change log

  • The CHANGELOG has been updated, or
  • This PR does not include user-facing changes and doesn't require a CHANGELOG update

Test coverage

  • This PR includes new unit and integration tests to go with the code changes, or
  • The changes in this PR do not require tests

Documentation

  • Docs (e.g. READMEs) were updated in this PR, and/or there is a follow-on issue to update docs, or
  • This PR does not require updating any documentation

@izgeri izgeri requested a review from a team as a code owner July 7, 2020 14:01
@izgeri izgeri self-assigned this Jul 7, 2020
Copy link
Contributor

@sgnn7 sgnn7 left a comment

Choose a reason for hiding this comment

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

@izgeri Few tiny nits

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Also reorganizes Windows section to be under "host with API key", since that
is what's being documented there.
Copy link
Contributor

@sgnn7 sgnn7 left a comment

Choose a reason for hiding this comment

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

@izgeri A few nits and comments


# Running services locally
This was generated by https://textart.io/sequence using the sequence:
Copy link
Contributor

Choose a reason for hiding this comment

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

This should be in a collapsed section I think - it's somewhat irrelevant if we include the pic

Copy link
Contributor Author

Choose a reason for hiding this comment

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

it's quite brief, so I'm ok with leaving it here rather than adding collapsed sections yet

CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Geri Jennings added 3 commits July 8, 2020 09:20
- Ensure lines aren't excessively long
- Put API key-based auth first in the docs, since it may be the most common
- Minor additional cleanup
Copy link
Contributor

@sgnn7 sgnn7 left a comment

Choose a reason for hiding this comment

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

@izgeri LGTM

@sgnn7 sgnn7 merged commit 3765ff2 into master Jul 8, 2020
@sgnn7 sgnn7 deleted the 97-cleanup-readme branch July 8, 2020 14:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants