Photo by Sigmund on UnsplashWhen working with MkDocs, if you run into an error that reads "Encountered unknown tag...", it will be a showstopper because the error will block the MkDocs build from proceeding any further. Let's see how you can fix such errors.Follow the instructions below to fix such an error:Navigate to the respective page that is indicated in ...
Photo by Dmitriy Demidov on UnsplashHave you run into the following Xcrun error when trying to use Git, via your Terminal, after installing MacOS updates? xcrun: error: invalid active developer path (/Library/Developer/CommandLineTools), missing xcrun at: /Library/Developer/CommandLineTools/usr/bin/xcrun I faced this issue after installing macOS updates with regard to Catalina version 10.15.7. I overcame the latter mentioned error by following the ...
Photo by Stephen Kraakmo on UnsplashWhen using GitHub as a collaboration tool to maintain documentation, you can contribute to the documentation in GitHub via Pull Requests (PRs) by adding new content and making improvements to the existing content. In addition, you can also review PRs sent by other contributors. The rich diff mode in GitHub does not display the ...
Photo by Jukan Tateisi on UnsplashGitHub is a platform that enables collaboration. It brings people together to work on projects and documentation from anywhere in the world. When I was new to GitHub, resolving errors was a painstaking process that sometimes resulted in me needing help from colleagues. However, whenever I ask for help, I always make sure to learn ...
Not heard about Duolingo yet? Then you are missing out on a load of fun.Duolingo is an educational tool that helps you learn new languages. Duolingo comes in the form of a mobile app or a web app. I used the free version of the mobile app for two weeks and after that I moved on to Duolingo Plus, which ...
Photo by Damon Hall on UnsplashSuppose your business has legacy SOAP web services. In that case, it does not mean that you need to painstakingly refactor your old solutions to expose those services to modern consumers like REST clients or mobile applications.Watch the following video to see how you can use WSO2 API Manager to help you make the transition ...
Image By - Brian Lundquist on UnsplashAfter I upgraded all my Homebrew local packages, which included Python and MkDocs, I ran into a series of errors when trying to build MkDocs and start the MkDocs server locally.A MkDocs setup generally needs specific Python packages to fulfill the required dependencies. Therefore, when you upgrade your Python version, you may need ...
Have you ever run into issues when adding images that are less than 200px in Confluence?Well, Confluence can be pretty stubborn at times!However, in reality a majority of your Confluence related issues may be due to various customizations that you have done (e.g., the styles that you added in your global and local stylesheets).However, all you have to do is ...
You can use the SimpleHTTPServer module that comes with Python to share files. Even though the thought of using Python SimpleHTTPServer may seem complicated it is not. It is so straightforward that you do not need to have any prior knowledge on Python programming. Using Python SimpleHTTPServer with MacFollow the instructions below to work with the Python SimpleHTTPServer:Sharing the filesFollow ...
There are many people in Sri Lanka who are passionate about technical writing, and who are very keen on keeping abreast of the latest trends and technologies in technical writing. Unfortunately, technical writing is a solo journey for many, because many organizations generally only have a single technical writer to handle the documentation for multiple products. The Vice President of ...
I have found that it is very useful to work with tabs in Confluence, because it helps to organize the content in a concise manner, and it also reduces the mental clutter in a reader’s head by allowing them to seamlessly just click on the tab respective to the information they were specifically looking for, without having to skim through ...
Haven’t you run into situations where you needed to copy and paste certain common content (e.g., certain configurations) when working with documentation in Confluence? Well, copying and pasting content is easy, but the downside of it sets in only when it comes to updating this content. The Atlassian Marketplace offers the following macros, which are supported by Confluence, to help ...
I was trying to add some code in a JIRA [1] and the comments starting with # in the code were appearing as bullets [2]. I was using Atlassian JIRA v6.0.1. This was distorting the information that I was adding in the JIRA. I added a backslash \ together with the special characters to over come this issue [3] & ...
Use the following command to search for a file in a directory using the entire file name or part of the file name:find . -name "*<FILE-NAME>*"If there are files that match the search criteria, the search results will display the exact path of the files.* The asterisk wild character at the beginning and end of the file name means any ...
I am an Apache Stratos committer. However, as a Technical Writer I mainly work with the Apache Stratos wiki documentation [1] and the necessity to commit anything to Apache Stratos repository had never arisen, until today. Today, I was requested to update the README.md file in the Apache Stratos repository, which appeared in [2]. The following are the steps that ...
Follow the instructions below in Atlassian Confluence to add Navigation tabs to your wiki space:NOTE: Only users with Admin permissions to the space can carryout the following steps.On the Browse drop-down menu, click Space Admin.Click on Themes, under Look and Feel.Click Configure Theme.In the Navigation text area, enter your wiki markup with the links you wish to display. For more ...
I have installed Add-ons many times on my browser and have gone through the phase of the Add-on button not showing on the browser toolbar or the add-on bar and have even solved the minute issue but somehow it slipped my mind today. So I thought I will blog the process down for future reference. Example:Adding Screen-grabber,On the Firefox menu, ...
I was wracking my head over how I can add a code using a macro and at the same time be able to add minor formatting to it (i.e. bold certain sections). I generally use the macro named "Code Block" when adding extracts of coding; but, as the Code Block macro does not support any sort of formatting it was ...
When it comes to Technical Writing the "Microsoft Manual of Style" is a good guide.This book can be downloaded for free from the following location,http://www.4shared.com/office/_wgskOSQ/MicrosoftMicrosoftManualofStyl.html
I use the Windows Vista Home Basic Operating system on my laptop and today the power icon simply disappeared from my taskbar. Instantly I assumed that somehow or the other the power icon must have got hidden by the “Hide” behavior getting enabled. So, I tried to follow the steps below. However, it did not work because when I tried ...
