Skip to content

Improve setup instructions#1523

Merged
devmount merged 5 commits intomainfrom
documentation/1491-improve-setup-instructions
Feb 26, 2026
Merged

Improve setup instructions#1523
devmount merged 5 commits intomainfrom
documentation/1491-improve-setup-instructions

Conversation

@devmount
Copy link
Copy Markdown
Collaborator

@devmount devmount commented Feb 19, 2026

Description of the Change

This change aims to sync the current setup flow with the documentation. Readme instructions were made more clear, less spread and more simple.

For testing, I recommend using a new/virtual machine, going through the main README.md, following all the setup instruction steps and check, everything works as described.

Benefits

Enhanced setup experience for self-hosters.

Applicable Issues

Closes #1491

@devmount devmount marked this pull request as draft February 19, 2026 21:19
Copy link
Copy Markdown
Collaborator Author

@devmount devmount left a comment

Choose a reason for hiding this comment

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

Here is a starting point, up for discussion.

Comment thread README.md Outdated
Comment thread README.md
@devmount devmount marked this pull request as ready for review February 26, 2026 09:31
@devmount
Copy link
Copy Markdown
Collaborator Author

@davinotdavid @rwood-moz @MelissaAutumn I updated the main README.md instructions to (hopefully) be more clear and straightforward. If you have the time to go through the installation process again, that would be awesome! If not, it's totally fine, then I gladly just take feedback on the README changes 🙏🏻 Either way: thanks so much for always giving great reviews 🙇🏻

Copy link
Copy Markdown
Contributor

@davinotdavid davinotdavid left a comment

Choose a reason for hiding this comment

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

Great start, thanks for removing the accounts specific part!

Someday soon™ when I bring back the accounts commands for creating the Keycloak clients I can add the instructions here.

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md
Copy link
Copy Markdown
Contributor

@rwood-moz rwood-moz left a comment

Choose a reason for hiding this comment

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

Thanks @devmount this is really helpful!

@devmount devmount merged commit 476c797 into main Feb 26, 2026
8 checks passed
@devmount devmount deleted the documentation/1491-improve-setup-instructions branch February 26, 2026 20:33
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.

Outdated readme documentation around create_client

3 participants