We use Github very heavily. Every line of code we've ever written lives on Github.
And there are users we've talked to who are in the same boat as us, it's just that they use Github releases to manage their release notes.
Which is fair. If you're an open source first company, or a company building for developers, or if the primary users of Github are your primary users managing your release notes on Github makes a lot of sense.
But here's the thing. You also want to maintain a nice public facing changelog / release notes for your product. Your managed version (if you're an open source company) needs a nice UI for users who're not on Github.
🎉 We've now made it possible for you to integrate your Github releases with Olvy, so you can continue to manage your releases on Github and we will automatically import them for you and serve it on your beautiful release notes page hosted with Olvy.
It's a few clicks, and you're integrated. Let us show you how.
There are some features like Featured Links, Categories, Projects, Contributors etc. that Github doesn't support, but don't worry, you can configure these options on Olvy once your release has been synced.
As always, we're always listening to all the feedback you have for us, so let us know.
Excited to see you ship wonderful things!
Olvy is a release notes tool, so naturally our releases text editor is a major part of our product. It felt odd to us that the editor experience we had live on the product was the one we built early on, and didn't make any major enhancements in the months since. Well, it changes today. We spent some time improving parts of the release editor, and made some minor enhancements.
We didn't have emoji support, which let's face it we should have had from day one. I mean what product doesn't have emojis! You can add emojis to your releases by just pressing
: and selecting the one you want ❤️
Also, it's now easy to reorder images in the editor with selections and the drop location highlighted for you. You can now directly paste and drop images from anywhere on the web or your clipboard.
We've also made the sidebar a little larger and organised it so that the features most frequently used by our customers are at the top.
Depends on what you call it. Apparently, the world hasn't yet agreed on a single term to use for this.
Example, the release you're reading right now would've had its release URL as:
This didn't look good when people (or us) shared a release note on social media. So, you can now customize whatever comes after your release note's URL.
So this release note is also available at:
You can customise it for your release notes in the release editor sidebar
That's it for this one folks! We've a few more releases scheduled for the coming weeks (using Olvy's schedule feature 😛), meanwhile let us know if you any more feedback on the editor 🤘
If there is a team behind it, and they’ve shipped something great, share the spotlight!
Introduce your users to the people building the tool they love.
It’s not something totally new and out of the blue, open source projects often have names of contributors in their changelogs.
AngelList allows you to add people to projects.
We thought “Cool! Why not allow our users to showcase people behind there releases”.
Invite your team to join Olvy and ask them to enrich their profile in the edit profile section. This data will be used to show their profile in your release notes.
In the editor, you will notice that we have introduced a new field in the settings section of the editor. Once you click on the field you will be able to see all your team in one place. You can search the respective team members who were part of the release and add them.
We have also added a very interesting twist to this feature (like we always do 😛). Olvy has always cared about feedback, so here we have introduced a way for your users to send a sweet gesture of appreciation to your team.
The feature is called thank you notes, every release where contributors are added your users will be to send a thank you feedback by clicking on the beautiful red heart icon.
We have added a new section in Feedback page called "Thank You Notes"
We also showcased behind the scenes of how Olvy is built 🥳 check out this super cool video by our team.
Hope you enjoyed this little fun feature, make sure you add your team members and celebrate your releases together.
Here is a small feature demo that we have added for you 😃
We've always had an option to add custom CSS to your releases page so that you get complete control over what your releases page will look like, but it wasn't easy for everyone. We know our users might not know a lot of CSS, so we're making some improvements to the appearance settings.
You can now customize the color scheme of your releases page as you like (with nice color pickers and staying 6 feet away from CSS).
Here's how it looks like.
Also, this does not mean custom CSS is going away. If you'd like you can always customize the look and feel by overriding with your own CSS as you've always done. Here's a link to our documentation with details on the CSS variables available for you to override.
Along with this, we also received feedback on our default Emojis. Their animated fun design didn't fit the brand of some of our customers, so we listened. Olvy now has support for multiple emoji styles, the original Olvy emojis are selected by default, but you can also now switch to Twitter's, Google's, or Apple's emoji styles (pick whatever fits better with your brand design)
That's it. Excited to see what you folks come up with, and let us know if you have any feedback.
Every release note you publish on Olvy gets social sharing options at the bottom of the release card. It's great! You've just launched something new and would like your users to know about it.
Well, what can we say, we thought so too.
Turns out, it's not something everybody wants on their releases page. Some people like to keep it private (foreshadowing an upcoming feature here).
So, now it is possible to disable social sharing links on your releases.
To do it, go to your appearance settings, and in the general tab you'll see a "Social Sharing" option right below the option to toggle release excerpts. Just disable them from there if you'd like.
What can we say, we've created a whole new category when it comes to category management UIs :p
We now show you a really nice preview of what your category with the theme colors you've selected would like on a release. Talking about theme colors, instead of just allowing you to change your category background and text colors we went a step further. We now check your selections against WCAG guidelines on color contrasts and tell you if the combination you've selected is a good one in terms of readability or not.
Another minor enhancement we've made on categories is on your releases page. The category selection dropdown which previously allowed you to filter by only one category at a time now allows you to filter your releases by multiple categories at a time. In order to do this, the UI has been changed to checkboxes which respect your category theme.
That's it. Let us know what you think about this change. Contrary to what Arnob's girlfriend tells him, he's always listening.
The release editor, where you write your releases got some minor updates. Your users can view your releases on your releases page or the widget you've added to your app. Knowing that it just didn't seem fair that the editor only gave you a preview of what your releases would look like on the releases page.
Now when you click on preview, you're given both options. You can preview the release on the releases page, or on the widget. When you click on the widget preview we open the widget in a sidebar to show you what it would look like inside a widget.
Also, right next to the publish button you'll notice an overflow(...) icon which will show you options to view the live release, view analytics for the release, unpublish the release, and if you want to delete your releases.
That's it. We'll soon make a lot more improvements to the editor, have them on the roadmap. You'll find a new release where you're reading this one when we do.
Until now we've supported two widget types, a modal, and a sidebar. We've always wanted more, like you have, and we've been listening. One widget that a lot of our users have asked for is an iframe embed.
So now it's a modal, a sidebar, and an embed. The embed can integrated the same way as the other widgets with user identification working the same way as before.
One small change in how to to use it would where you previously used a button element as your target, you should now use a div, or another other element as the container as your releases will be embedded inside that element.
The embed takes the height and width of its parent container, so if you to set a size for it, just add a height and width to the target element.
That's it. You can generate the code for the embed widget from the Install Olvy tab.
There was an issue with the sidebar on small screens where the options at the lower side weren't usage. We've fixed that.
A very minor copy change in the release editor which instead of showing "Updated since last published" now shows "Saved x seconds ago" which we believe is more clear.
The unread indicator on the widgets now is a little larger because turned out numbers weren't much readable in the small size.
Your widget and releases page now loads even more faster 🚀
We displayed an excerpt of your release note on the home page with an option for your users to click "Read More" to view the complete release. It worked fine, but we received some feedback and we've made the updates.
First things first, there was an issue where the release excerpt didn't have the formatting added to the release note. That is now fixed. The release excerpt now maintains formatting of your release note. So yayyy... I guess
Now the fix aside, what if you don't want the release excerpt at all? Some of our users didn't. We've added an option to disable release excerpts in appearance settings. If you have excerpts disabled we will not show the "Read More" thing and instead show the complete release note on the home page.
That's it. This was a small release note, but I don't want to show the whole thing on the homepage, so I have release excerpts enabled and that's why you had to click on "Read more" to read this line (if you're coming from the homepage, that is).
Anyway, as usual. The feedback box is open. Let us know if you face any issues, or have some more suggestions for us
Here's an exciting new update! You can now enable user identification to see the details of the users who comment on your release by following some simple steps. User identification can help you understand how each of your users interacts with your releases, and if you'd like, you can reach out to them personally to discuss the feedback that you may have received.
If you click on 'Install Olvy' on the left sidebar menu and scroll to the bottom, you'll see a User Identification section. As mentioned there, to enable user identification on your release feedback, in your codebase, after initializing Olvy's script on your page, call the
Olvy.setUser function with the details of the user.
You can pass the below four user parameters in the function,
name – Your user’s name
email – Your user’s email address
identifier – A unique identifier of your choice, like a user id or a username
meta - Add any other information of the user, like the tenant or organization they belong to, etc.
On clicking on 'Feedback' on the left sidebar menu, you'll see a 'Submitted by' column, which will show the name and email id of the user who made the particular comment.