-
-
Notifications
You must be signed in to change notification settings - Fork 101
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
Rename Client Config to Account Data #2032
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I assume this is related to #2030.
Thank you for the contribution. It's a fair start, but - even though I said "don't try to solve everything at once" - I think this is the opposite extreme. Just changing the list of modules, without actually changing the name of the section itself, is going to cause confusion. Perhaps you could update your PR so that you're also changing the name of the section itself.
A couple of other points to note:
- It's helpful to give a bit of description in the PR title about what the PR is trying to achieve. "Update _index.md" doesn't really tell anyone anything.
- You've ticked "Pull request includes a sign off", but your pull request does not, in fact, include a sign off.
Signed-off-by: Ved Prasad Bankeshwar [email protected]
Thank you for the suggestions, I have tried implementing them to the best of my knowledge. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please let me know if I have to make a changelog entry too, I couldn't figure out where to do it.
Yes, every PR must have a changelog entry. Are the instructions not clear in CONTRIBUTING.rst?
Also this qualifies as "other changes" as far as I can tell.
changelogs/legacy/client_server.rst
Outdated
@@ -557,7 +557,7 @@ Since the draft stage, the following major changes have been made: | |||
- Invites based on third-party identifiers | |||
- Room tagging | |||
- Guest access | |||
- Client config | |||
- Account Data |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You should not edit an old changelog entry.
data/api/client-server/keys.yaml
Outdated
@@ -15,7 +15,7 @@ | |||
# limitations under the License. | |||
openapi: 3.1.0 | |||
info: | |||
title: Matrix Client-Server Client Config API | |||
title: Matrix Client-Server Account Data API |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think this is quite right (but it was already wrong before). Looking at the spec it looks like it should be "Key Management API" for this file.
content/client-server-api/_index.md
Outdated
@@ -2927,7 +2927,7 @@ that profile. | |||
| [Typing Notifications](#typing-notifications) | Required | Required | Required | Required | Optional | | |||
| [User and Room Mentions](#user-and-room-mentions) | Required | Required | Required | Optional | Optional | | |||
| [Voice over IP](#voice-over-ip) | Required | Required | Required | Optional | Optional | | |||
| [Client Config](#client-config) | Optional | Optional | Optional | Optional | Optional | | |||
| [Account Data](#client-config) | Optional | Optional | Optional | Optional | Optional | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You also need to apply changes to the URL fragment. #client-config
should have been changed to #account-data
, here and maybe in other parts of the spec.
1. Added a changelog entry 2. Modify URL fragment 3. restore accidental change in changelog entries
changing the URL fragments in a few missed spaces
Part of issue #2030.
Pull Request Checklist
Preview: https://pr2032--matrix-spec-previews.netlify.app