Skip Navigation
Git Workflows for API Technical Writers · Bump.sh
bump.sh Git Workflows for API Technical Writers · Bump.sh

Technical writers are often challenged with keeping API documentation in sync with an ever-evolving API design. This article explores the challenges and solutions for tackling this ongoing struggle, focusing on parallel development and leveraging automation to streamline the process.

Git Workflows for API Technical Writers · Bump.sh
0
Git isn't working when i clone, fetch, or push
  • Not sure but that sounds like you have a problem with your Git installation (or a dependency of Git). Maybe a reinstallation can solve that.

  • How Git Works (zine by Julia Evans)
  • I understand the "why would I pay for this" reaction. I think crowdsourcing is a better approach for these kinds of content. Once you reach certain level of financial commitment from the crowd, you can give away the PDF and sell the print copy.

  • Your API Shouldn't Redirect HTTP to HTTPS
    jviide.iki.fi Your API Shouldn't Redirect HTTP to HTTPS

    Instead of redirecting API calls from HTTP to HTTPS, make the failure visible. Unfortunately, many well-known API providers don't currently do so.

    Your API Shouldn't Redirect HTTP to HTTPS
    13
    What were your misconceptions about Git when you first started?
  • git branches are just homeomorphic endofunctors mapping submanifolds of a Hilbert space

    Yeah, once you realize that everything falls into place.

  • What were your misconceptions about Git when you first started?

    I used CVS and ClearCase before moving into Git, and it took me some time to adjust to the fact that the cost of branching in Git is much much less than ClearCase. And getting into the "distributed" mindset didn't happen overnight.

    82
    Securing Git: Addressing 5 new vulnerabilities
    github.blog Securing Git: Addressing 5 new vulnerabilities

    Git is releasing several new versions to address five CVEs. Upgrading to the latest Git version is essential to protect against these vulnerabilities.

    Securing Git: Addressing 5 new vulnerabilities
    0
    Refreshing Human-Cola.
  • The shape of that bottle is creepier than the text.

  • Git alias idea: "git browse" to open repo in browser
  • I believe you can replace start with the command that is suitable for your system (e.g., xdg-open for linux).

  • Git alias idea: "git browse" to open repo in browser
    hachyderm.io Dan Schroeder (@deadlydog@hachyderm.io)

    Attached: 1 image My most used #git alias? "git browse" to open the repo's remote URL in the web browser. Works for #GitHub, #AzureDevOps, #BitBucket, etc. Set it up with: git config --global alias.browse 'start `git config remote.origin.url`' "start" only works on Windows tho. Requires a https (...

    Dan Schroeder (@deadlydog@hachyderm.io)
    4
    What details/tools have you found help people transition to similar, open software from closed software, or think could help?
  • The only such transition I was involved in was switching from TFS to Git, and there was no discussion. It was the obvious thing to do and for a while we needed to support some developers who are new to Git.

    So, it all depends on the type of change you want to implement. Most people don't think much about a piece of software being open is significant. That's why the main selling point should be the product itself. Especially in organizations openness alone is not a strong enough argument.

    But with individuals, it may help to inform people about FOSS instead of just suggesting alternatives ("Do you have a moment to talk about our lord and savior Stallman/Torvalds?"). If the individual doesn't understand or subscribe to the values, the switch may be temporary. My 2 cents. Hopefully others will come up with better tactics.

  • What details/tools have you found help people transition to similar, open software from closed software, or think could help?
  • If you are thinking about transitioning an organization to open source, pricing and vendor lock-in are generally good arguments.

    If you are thinking about helping individuals transition, that's a bit more difficult. Pricing could still work, but is not always that effective. It boils down to the willingness to try something new.

    In both cases projects with good documentation and a healthy community also helps, but if the open alternative lacks features, it's a though sell.

  • How do I not stop feeling like I am doing nothing outside work?
  • I am not concerned about not having anything to show for my free time. I am just not finding interest doing stuff which could indicate something worse.

    You are not alone. It's not easy to find an engaging free time activity. And even if you do, you may get bored of it after some time. The only thing I can say is: even if something doesn't seem very interesting at first, give it a try anyway (as long as it doesn't require a huge upfront investment). You may end up liking the activity or you may end up with like-minded people. And the worst case scenario is, you have wasted some time.

    I think majority of people suffer from not having a meaningful free time activity (amplified by the possibilities of internet). And I'm saying this without any data to back it up, so don't quote me on that.

  • How do I not stop feeling like I am doing nothing outside work?
  • Not having any personal projects is perfectly fine. Don't worry about it. Not everyone has to have their job as their hobby. Try other things (music, hiking, cooking, etc.). Try to find a hobby that makes you happy (if you don't already have one). That's way more important than having a public GitHub profile. And if a company decided not to hire you because of that, you basically dodged a bullet.

  • Why single vendor is the new proprietary
  • That's an unnecessarily strong reaction. Money clearly matters for some things. But that's not all that matters. There are many people releasing FOSS without any financial expectations. Clearly, money doesn't matter to those people on that context. Trying to argue that "money should matter also for those people on that context" doesn't make too much sense to me. Nobody is forcing anybody to release FOSS.

  • Why single vendor is the new proprietary
  • Sorry, I don't follow your reasoning. Why would a company not making money be a relevant problem for the advocates of FOSS? FOSS is about freedom. It never had an opinion about money. Money has always been irrelevant. Some people may not like it, and they are free to not use non-free licenses. And FOSS advocates will warn users about that (as they did in the past). FOSS doesn't have an obligation to offer a solution to every problem in the software industry.

  • Why single vendor is the new proprietary
  • I don't think that is relevant from author's (and OSI's) point of view.

  • Why single vendor is the new proprietary
  • Here is my understanding of author's position: Stay away from companies like Redis and ElasticSearch. They are building software with a proprietary mindset (the fact that they have tight control over product strategy and development demonstrates this) only to realize that they are being devoured by bigger fish. It's a business model problem, not an open source problem.

  • DistroWatch has been banned in Turkey
  • Here is the link to the original website (an NGO that monitors blocked websites in Turkey): https://ifade.org.tr/engelliweb/distrowatch-erisime-engelledi/

    And here is the Google translation of the text on that page:

    The IP address of the DistroWatch platform, which provides news, reviews, rankings and general information about Linux distributions, was blocked by the National Cyber ​​Incident Response Center (USOM) on the grounds of "IP hosting/spreading malware".

  • Garnet: Redis alternative from Microsoft
  • I think you are highlighting an important point that are missed by other commenters emphasizing the developer. I prefer GPL over MIT license. But this is a possible fallback if Redis decides to change its licensing (like several others did).

    I think these kind of products have strategic significance for MS for their Azure offering. They are probably preparing to offer this there (in addition to and as an alternative to Redis). So, it makes sense for Microsoft to release this with an OSS license (otherwise no one will adopt it).

  • How do our ideas about coding affect the software we create? - Christin Gorman - NDC Oslo 2022
  • I often think language skills also has a significant impact on code quality. When I have trouble "naming things" (as opposed to "cache invalidation") I use dictionaries and thesauruses. "Naming" is an important part of organization and improving language skills help a lot.

  • Forget about OAuth 2.0. Here comes OAuth 2.1 - Philippe De Ryck - NDC Oslo 2022
  • In his NDC talk, Philippe De Ryck provides a good summary on why we should:

    • no longer use the implicit grant
    • use backend-for-frontend for security-sensitive web applications
  • Event Storming - Alberto Brandolini - DDD Europe 2019
  • You don’t get to laugh a lot while watching a conference talk on DDD. I highly recommend this very dynamic talk by Alberto Brandolini at DDD Europe. Event Storming and pineapple don’t mix well.

  • canpolat canpolat @programming.dev

    Mastodon: @canpolat@hachyderm.io

    Posts 332
    Comments 134
    Moderates