Armory Docs Get a Face Lift!
Jun 19, 2020 by Aimee Ukasick
Pardon the dust and noise. If you visited docs.armory.io Friday afternoon, you might have noticed that it looks different. Very different. The Documentation Team at Armory is excited to announce the launch of our new documentation website!
Here are some changes you can take advantage of right now:
- Better native search functionality
- Better in-page navigation
- Nicer look and feel
Deeper Dive into Changes
We’ve improved the search functionality on our documentation. More enhancements are in the pipeline!
Previously, Armory’s documentation wasn’t versioned. This meant that docs.armory.io had the content for all Armory Spinnaker versions. Going forward, we will version our documentation to match the Armory Spinnaker version. If you are on Armory Spinnaker 2.19.x or lower, use the 2.19 documentation version. It has all the great content that the old docs.armory.io site had.
If you’re using a more recent release, things will be a little different. Documentation for Armory Spinnaker 2.20.x and higher will get versioned based on the Armory Spinnaker version. This means that you should select the version that corresponds to your Spinnaker version. When you select the 2.20 documentation, you’ll only see the content for features and functionality that exists in Armory Spinnaker 2.20. This is a change we’re making for 2.20 and all subsequent releases.
We hope this change makes it less confusing when you look up documentation for a feature you’re using.
The way our URLs are generated have changed. If you bookmarked a page previously, it should still work. If it doesn’t, open an issue and let us know! Otherwise, please update your bookmark.
Here are a few things we’re working on next to continue improving our documentation:
- An even better search experience
- Better content organization
- Reviewing and updating content
Have a change you really want to see in our documentation? File an issue or even make a pull request!