Open Hour 2022-JAN-6
January 6, 2022 - Alyssa Rock
- General updates and announcements
- The Salty 5
- Community forum updates
- Salt docs updates
- Salt Enhancement Proposals
- Help wanted
- Q&A plus discussion
General updates and announcements
- Happy New Year!
- Spread the word among your networks about Open Hour to help us boost attendance.
- Open Hours are held every 1st and 3rd Thursday from 10a.m. to 11a.m. Pacific.
- Our next Salt Community Open Hour will be January 20th.
The Salty 5
- This is a new segment of the Open Hour!
- In this segment, Salt Project community members can share interesting projects they’re working on with Salt.
- The goal is to inspire fellow community members to get creative and share insights about how they’re using Salt.
- Each project will have 5 minutes or less to present their project and we can do more than one at a time if enough people want to share.
Community forum updates
- This week’s featured issue: adding logging when trying to debug.
- The problem is that the file client does not include minion information in its request because it’s one-to-one communication.
- So how do you tell what’s going on? The best advice is to add the minion id to the file client request.
- Thomas suggested that we might want to consider making that the default in the software because that could help with auditing.
- As another piece of troubleshooting advice, when you’re having trouble tracking something down, feel free to throw in a log every now and then. Some developers adds all caps XXX to the beginning of code markers to help him grep his logs. Some use five hashes.
Salt docs updates
- Join us for the first Salt Docs working group meeting of the year: Tuesday, January 11 at 3p MST / 2p PST / 22:00 UTC.
- In that meeting we’ll plan our group goals and key documentation initiatives for the next cycle.
- We have migrated the Docs working group repo to GitLab: https://gitlab.com/saltstack/open/docs/docs-hub
- You can use this repository to get information about joining the group and other ways that you can contribute to the docs.
- This repo also contains the docs triage process if you want to read about how we handle doc feedback requests.
- In our next working group meeting, we’ll also talk about the new Salt Docs Docs Roadmap where community members and other stakeholders can view, request, and upvote big documentation improvements and initiatives. Check out https://saltdocs.prodcamp.com/
- The goal of the Salt Docs Roadmap is to provide visibility to major documentation tasks. Alyssa wanted a way for community members and other stakeholders to see, upvote, and request major documentation improvements. In essence, this tool is a way of collecting and displaying that feedback to help the docs team prioritize their work.
- The roadmap currently shows the improvement proposals that Alyssa gathered over several months talking with various Core team members, community members, and stakeholders.
- Feel free to come to this site and explore proposals for what we might work on next. Add your upvotes or comments. You can also come to this site to see what the team is working on currently.
Salt Enhancement Proposals (SEPs)
- We are renewing our focus on SEPs so that we can make sure that we don’t neglect the SEPs or let them fall by the wayside. The team is going to have some internal conversations to streamline our process for handling them. Keep an eye out for changes to our process.
- Wayne spent some time summarizing the currently open SEPs and discussing next steps for each.
- The core team is adding “help wanted” labels to issues that would be great for community members to tackle. These issues are ones that the team would love to get merged or work on, but that they don’t have the bandwidth for. It’s a great way to help the project and get started working with Salt. Look through the issues with that label and see if something piques your interest: https://github.com/saltstack/salt/labels/help-wanted
- Here’s some highlighted issues:
- Has a guess, needs tests: https://github.com/saltstack/salt/issues/9939
- Has a PR, but author is busy and needs tests: https://github.com/saltstack/salt/pull/57670
- Need verified, but still a problem. Needs a fix and tests: https://github.com/saltstack/salt/issues/28940
- Needs merging of efforts: https://github.com/saltstack/salt/pull/60537
Q&A plus discussion
- Q: What is the difference between a SEP and a regular PR?
- A: Salt Enhancement Proposals are intended for large improvements we want to make to the Salt architecture or project. Any large change should go through a SEP so that the rest of the community can comment and make suggestions for improvements to the proposal. SEPs are kept in their own separate repository that gives us a place where we can open a proposal and have the discussion and comment about the changes we want to make. Check out the README for more information: https://github.com/saltstack/salt-enhancement-proposals/blob/master/README.md
- Q: How do I edit the Salt documentation? I want to contribute to it.
- A: Editing the Salt documentation uses the same process as editing or contributing to the Salt codebase (at least for the module/state documentation and core Salt docs). You can follow the Salt contributing guide to set up for your environment and learn how to contribute to the documentation: https://github.com/saltstack/salt/blob/master/CONTRIBUTING.rst
- For other types of contributions besides the module/state documentation or the Core Salt docs, join the #documentation channel on the Salt workspace and we’ll try to help you get started: https://saltstackcommunity.slack.com/
- Q: Looking to get this un-stuck: https://github.com/saltstack/salt/pull/61207
- A: We’ll take another look at it.
- Q: Is there someone who can help get this merged? The failure involves pip installation but I don’t know what the problem is. https://github.com/saltstack/kitchen-salt/pull/340
- A: It looks like that salt-kitchen PR is failing because it’s trying to install a version of Salt that is not able to be installed. We restarted the PR jobs to see if it fails again. If it fails, we can dive deeper to see what is causing the failure.
- Q: Any movement on this from the SRE team? https://github.com/saltstack/salt/issues/61345
- A: We’ll remind the SRE team to take a look. They are a little stretched thin right now.
- Q: Any chance these can get looked at?
- Q: I’m having issues understanding the test failures here. The tests run locally for me. I do not understand how the jenkins env is different: https://github.com/saltstack/salt/pull/61418
- A: Something could be overwriting __opts__ when all tests are run. Also make sure you are running the same nox command locally that Jenkins is running.