docs: fix 'allow to retrieve/configure' grammar in spire_server federation docs

Open Beginner friendly
#7,283 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
92/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Domain
documentation

Research direction

Open doc/spire_server.md and find the refresh_hint description and the https_web profile note. Correct the grammar as suggested, then review both passages to confirm the wording is grammatical and no unrelated documentation changes are included.

Written by the indexing model from the issue text.

Description

priority/backlog
  • Version: main (docs)
  • Platform: n/a (documentation)
  • Subsystem: documentation / spire_server federation

In doc/spire_server.md:

  1. refresh_hint description: "Small values allow to retrieve trust bundle updates..."
  2. https_web profile note: "https_web allow to configure either..."

Suggested fixes:

  1. "allow retrieving" (or "allow you to retrieve")
  2. "https_web allows configuring" (also subject-verb agreement)

Docs-only; happy to send a PR.

Dominant language
Go
Stars
2.5k
Forks
662
Avg merge
4d 4h
Merged PRs (30d)
40

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from spiffe/spire

All issues in spiffe/spire

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.