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

Update docs/configuring-well-known.md and docs/installing.md #3767

Merged
merged 11 commits into from
Nov 15, 2024

Commits on Nov 13, 2024

  1. Update docs/configuring-well-known.md: remove redundant information

    For example, anchor links to the headers are distractive as these headers are displayed by scrolling a bit.
    
    Also: edit section headers
    
    Signed-off-by: Suguru Hirahara <[email protected]>
    Suguru Hirahara committed Nov 13, 2024
    Configuration menu
    Copy the full SHA
    191dad6 View commit details
    Browse the repository at this point in the history
  2. Update docs/configuring-well-known.md: add "Support service discovery…

    …" as a type of well-known service discovery
    
    Signed-off-by: Suguru Hirahara <[email protected]>
    Suguru Hirahara committed Nov 13, 2024
    Configuration menu
    Copy the full SHA
    15d6522 View commit details
    Browse the repository at this point in the history
  3. Update docs/configuring-well-known.md: recategorize the sections abou…

    …t installing well-known files on the base domain's server
    
    The commit merges the content of the option 2 with the section above, as both explain how to serve the base domain via the playbook and claim it is the easy way of installing well-known files, and therefore the content is repetitive.
    
    Signed-off-by: Suguru Hirahara <[email protected]>
    Suguru Hirahara committed Nov 13, 2024
    Configuration menu
    Copy the full SHA
    be135ab View commit details
    Browse the repository at this point in the history
  4. Update docs/configuring-well-known.md: create a section for types of …

    …well-known service discovery mechanism
    
    Signed-off-by: Suguru Hirahara <[email protected]>
    Suguru Hirahara committed Nov 13, 2024
    Configuration menu
    Copy the full SHA
    db030f3 View commit details
    Browse the repository at this point in the history
  5. Update docs/configuring-well-known.md: add a link to the Matrix Speci…

    …fication, to which MSC 1929 was implemented
    
    MSC 1929 has no longer been for an early adopter.
    
    Signed-off-by: Suguru Hirahara <[email protected]>
    Suguru Hirahara committed Nov 13, 2024
    Configuration menu
    Copy the full SHA
    e5f0536 View commit details
    Browse the repository at this point in the history

Commits on Nov 14, 2024

  1. Update docs/configuring-well-known.md: iterate

    Signed-off-by: Suguru Hirahara <[email protected]>
    Suguru Hirahara committed Nov 14, 2024
    Configuration menu
    Copy the full SHA
    8cb139e View commit details
    Browse the repository at this point in the history
  2. Update docs/configuring-playbook-base-domain-serving.md

    Co-authored-by: Slavi Pantaleev <[email protected]>
    luixxiul and spantaleev authored Nov 14, 2024
    Configuration menu
    Copy the full SHA
    c173527 View commit details
    Browse the repository at this point in the history
  3. Update docs/configuring-well-known.md

    Co-authored-by: Slavi Pantaleev <[email protected]>
    luixxiul and spantaleev authored Nov 14, 2024
    Configuration menu
    Copy the full SHA
    bcc6319 View commit details
    Browse the repository at this point in the history
  4. Update docs/installing.md: iterate

    Summary:
    - Try to reflect review comments
    - Declare that the shorter user identifier is recommended
    - Add a note about installing the server matrix.example.com directly, with the link to the FAQ entry
    
    Signed-off-by: Suguru Hirahara <[email protected]>
    Suguru Hirahara committed Nov 14, 2024
    Configuration menu
    Copy the full SHA
    595ec4a View commit details
    Browse the repository at this point in the history
  5. Update docs/installing.md: replace the anchor link to docs/configurin…

    …g-well-known.md with one to docs/howto-server-delegation.md
    
    Service Discovery via .well-known files is one of the two ways for server delegation, and it is possible to set up server delegation via a DNS SRV record instead (though it is more advanced and complicated), so it should be more proper to use the words "delegation/redirection" than "service discovery".
    
    Signed-off-by: Suguru Hirahara <[email protected]>
    Suguru Hirahara committed Nov 14, 2024
    Configuration menu
    Copy the full SHA
    b0d9ecf View commit details
    Browse the repository at this point in the history
  6. Update docs/configuring-well-known.md: fix a typo

    Signed-off-by: Suguru Hirahara <[email protected]>
    Suguru Hirahara committed Nov 14, 2024
    Configuration menu
    Copy the full SHA
    474da4b View commit details
    Browse the repository at this point in the history