devportal VS Visual Studio Code

Hello folks, I am running a tech writing team (along with product management). I am not expert in documentation platforms. Today we have a challenging custom-built documentation platform based on Sphinx and a bunch of cobbled together technologies aiven/devportal: Resources for users of the projects on the Aiven platform (github.com) . Our documentation is in .rst markup language due to the Python focus.

Humble brag that the last one in the list (Aiven 🦀) won 2022 DevPortal Awards in the category Best DevPortal Beyond REST Platforms. If I added a list of great docs websites but didn't include the OG, it would be a crime. Check out one of THE BEST documentation out there - Stripe Docs, built using Markdoc.

You can find a list of Aiven's cloud providers on [Developer.aiven.io], which is also the portal where we host the developer documentation. To quickly retrieve a list of currently-available cloud providers, my colleague Lorna Mitchell wrote a Python script that pulls our cloud listing from the Aiven API and generates documentation, which is really cool!

Visual Studio Code (VS Code): Developed by Microsoft, VS Code is a lightweight yet powerful IDE with extensive support for Python development through extensions. It offers features like IntelliSense, debugging, and built-in Git integration.

In VSCode for example this can be easily done by adding the following .vscode/launch.json file:

I had a near-identical experience. I looked into switching in 2019 and ran into this 2016 bug which was a showstopper for me. Fixed it myself, grand total 4 line diff. https://github.com/microsoft/vscode/issues/10643

When working in Visual Studio Code (VS Code), always create a new Python file for your project.

Code Editor: Choose a code editor like Visual Studio Code that offers good support for web technologies and extensions for PWA development.

When working in Visual Studio Code (VS Code), create a new Python file for our music player project. It's helpful to have separate files for different parts of your project.

https://github.com/microsoft/vscode/forks

27,000 people seem to have done so.

Choosing IDE: Selecting a suitable Integrated Development Environment (IDE) is crucial for efficient coding. Consider popular options such as PyCharm, Visual Studio Code, or Jupyter Notebook. Install your preferred IDE and ensure it's configured to work with Python.

I was doing it all wrong, designing and developing on the fly, using the same tool - VScode; Making one step forward and ten back when I mess up with good code while trying to get rid of the bad. I had gotten away with it for three pages, but it had finally caught up with me.