Join devRant
Do all the things like
++ or -- rants, post your own rants, comment on others' rants and build your customized dev avatar
Sign Up
Pipeless API
From the creators of devRant, Pipeless lets you power real-time personalized recommendations and activity feeds using a simple API
Learn More
Search - "wiki documentation"
-
I started coding in 1994 making .BAT menus for my DOS games. Used HELP.EXE to find commands I could use. Then I figured out how to modify and run GORILLA.BAS (using Q-Basic). Man, when I realized that all BASIC commands were in the OS documentation as well, that was the Red Pill! Just started to copy commands and blocks from the Gorillas game into a new program, read the doc, modify, run and learn. Btw, the first BASIC command I played with was "PLAY" (for music).
At that time I was 10 and there was no Stackoverflow, no Youtube, no tutorials, no Google... no easy path to follow down the rabbit hole.
Ref: https://en.wikipedia.org/wiki/...10 -
TFW your client's git policies are so draconian that the dev teams use "develop" as trunk, and completely ignore the release process.
I wrote up 50 pages of git standards, documentation and procedure for a client. Bad indian director 9000 decides the admin (also Indian) who specializes in Clearcase and has no git or development experience is more qualified to decide and let's him set the policy.
FF to today:
- documentation, mostly contradictory, is copy pasted from the atlassian wiki
- source tree is the standard
- no force pushing of any branches, including work branches
- no ff-merge
- no rebasing allowed
- no ssh, because he couldn't figure it out...errr it's "insecure"
- all repos have random abbreviated names that are unintelligible
- gitflow, but with pull requests and no trust
- only project managers can delete a branch
- long lived feature branches
- only projects managers can conduct code reviews
- hotfixes must be based off develop
- hotfixes must go in the normal release cycle
- releases involve creating a ticket to have an admin create a release branch from your branch, creating a second ticket to stage the PR, a third ticket to review the PR (because only admins can approve release PRs), and a fourth ticket to merge it in
- rollbacks require director signoff
- at the end of each project the repo must be handed to the admin on a burned CD for "archiving"
And so no one actually uses the official release process, and just does releases out of dev. If you're wondering if IBM sucks, the answer is more than you can possibly imagine.11 -
So I just spent the last few hours trying to get an intro of given Wikipedia articles into my Telegram bot. It turns out that Wikipedia does have an API! But unfortunately it's born as a retard.
First I looked at https://www.mediawiki.org/wiki/API and almost thought that that was a Wikipedia article about API's. I almost skipped right over it on the search results (and it turns out that I should've). Upon opening and reading that, I found a shitload of endpoints that frankly I didn't give a shit about. Come on Wikipedia, just give me the fucking data to read out.
Ctrl-F in that page and I find a tiny little link to https://mediawiki.org/wiki/... which is basically what I needed. There's an example that.. gets the data in XML form. Because JSON is clearly too much to ask for. Are you fucking braindead Wikipedia? If my application was able to parse XML/HTML/whatevers, that would be called a browser. With all due respect but I'm not gonna embed a fucking web browser in a bot. I'll leave that to the Electron "devs" that prefer raping my RAM instead.
OK so after that I found on third-party documentation (always a good sign when that's more useful, isn't it) that it does support JSON. Retardpedia just doesn't use it by default. In fact in the example query that was a parameter that wasn't even in there. Not including something crucial like that surely is a good way to let people know the feature is there. Massive kudos to you Wikipedia.. but not really. But a parameter that was in there - for fucking CORS - that was in there by default and broke the whole goddamn thing unless I REMOVED it. Yeah because CORS is so useful in a goddamn fucking API.
So I finally get to a functioning JSON response, now all that's left is parsing it. Again, I only care about the content on the page. So I curl the endpoint and trim off the bits I don't need with jq... I was left with this monstrosity.
curl "https://en.wikipedia.org/w/api.php/...=*" | jq -r '.query.pages[0].revisions[0].slots.main.content'
Just how far can you nest your JSON Wikipedia? Are you trying to find the limits of jq or something here?!
And THEN.. as an icing on the cake, the result doesn't quite look like JSON, nor does it really look like XML, but it has elements of both. I had no idea what to make of this, especially before I had a chance to look at the exact structured output of that command above (if you just pipe into jq without arguments it's much less readable).
Then a friend of mine mentioned Wikitext. Turns out that Wikipedia's API is not only retarded, even the goddamn output is. What the fuck is Wikitext even? It's the Apple of wikis apparently. Only Wikipedia uses it.
And apparently I'm not the only one who found Wikipedia's API.. irritating to say the least. See e.g. https://utcc.utoronto.ca/~cks/...
Needless to say, my bot will not be getting Wikipedia integration at this point. I've seen enough. How about you make your API not retarded first Wikipedia? And hopefully this rant saves someone else the time required to wade through this clusterfuck.12 -
When in internship you have to read 150000 lines of code to make changes and the code does not have any comments, no indentation, no documentation, no wiki. You'll be like fuck this shit. I'm outta here.1
-
When you click on the github wiki of the API you wanted to use and it shows you the "Create the first page" banner....
Guess I'll have to find another API with proper fucking documentation.2 -
You know how a normal developer will start writing a program, and then take the big pieces and split/refactor it; move hard coded things into functions that take arguments, and cleaning up along the way?
Our manager makes a tons of empty files, and empty directories, with how he thinks he wants to build something, and checks them all in. Tons of .gitkeep files in empty directories, blank Jenkinsfile, Dockerfile that doesn't build.
When he makes wiki documentation, there are tons of subsections, all of which are links to pages with "TODO" in them.
Dear god stop it you asshat! Stop making tons of empty files and pages. Write the thing in one chunk and then split it as needed like someone who actually knows how to engineer software!1 -
Confluence WYSIWYG editor for tables on wiki pages. Forget about git and GitHub idiosyncrasies, "at the end of the day" project documentation in Confluence and Jira is the real challenge.1
-
You know that moment, when you look for something on wikipedia, and after few hiperlinks you are reading about influence of penguins on Mars' day length or othen nonsense?
Just happened to me like 4th time when reading Django documentation. It is so well written and easy to understand, that I just click and click and want to go deeper, and then realise I have to read what I need, because I never ever got to it in the first place.
Gotta love the people who make such docs. I never could, and prbly will.1 -
Writing documentation is one of those tasks that most developers don't like doing. Especially when it comes to writing in say a Word/PDF file, an online wiki, or Confluence. It's time consuming and a pain in the ass.
But even if you don't like it, at least write comments in your source code! I hate having to keep writing "Write the PHPDocs for this class/function" in every pull request that I review. It's wasting my time writing such comments when it's such a basic thing to do when writing source code.30 -
It was the worst local Hackathon. It's not even a Hackathon either, where the whole event spanned over 2 months.
It was a group entry with me and 4 teammates. Each of them did contribute:
Guy A: criticizes what is built and designed
Guy B: offered financial tips on how to make this thing feasible
Guy C: did UI but in graphics. No CSS file, just bits of graphical elements.
Guy D: family commitments
And then there's me, writing documentation, built the entire project, wiki, drove the project, prepared the presentation slides, tests the framework, unit tests, stuck with stupid problems like SSL, localhost, Google Maps Key and the likes.
And we didn't even win, let alone launch this thing, whatever it is, to anywhere. Never doing group projects again.
I'm flying solo for now -
Hey documentation providers! Some of us don't want to have to go to slow ass websites to look up everything about your code, system, library, api, etc. It also really sucks when trying to work on those systems without an internet connection. So, please provide offline documentation.
A special thank you to Python for providing help files with Python itself. This has been a life saver when working offline.
Also a special fuck you to Bethesda for not providing an offline version of the Creation Kit wiki. Everything else you do is nice, but please provide offline docs.11 -
So I just spent all morning struggling setting up a project and getting it to run. My colleague sent me a screenshot of the documentation wiki, but didn't give the link.
*4 hours later looks at email for the Nth time*
Wait he did... that's not a wiki, that's Readme.md... this is in the repo link right above it!
I didn't need to checkout the repo so didn't open it... -
Imagine you decide to spend a few hours to contribute to an open-source project wiki/documentation that hasn't been updated in years, to actually make it useful for new users, and then the maintainers start expecting further modification and corrections from you before pulling the PR, like you work for them, instead of just fucking pulling it in and then editing what they want themselves. It's just another example of how stupid and nonsense the open-source community can be.3
-
My manager put "Architecture Diagram" onto my list of tasks. "Do you have a diagram"? came up in our last call.
No, I don't have a diagram like your useless block diagram that shows nothing of what we've done. Instead I have a ton of wiki pages, real documentation, READMEs in each git repo that are detailed and complete, unless you're repos of empty directories, `.keep` files, empty READMEs and blank "TODO" wiki pages!6 -
So my team started creating an in-house wiki for all information about our products, methods, scrum, documentation etc. From the beginning we had settled on doing everything in English instead of native language just in case we get a foreign student intern or simply a foreign employee... And now it looks to me that nobody but my team leader and I care about it: half of the documents are either fully native (especially from other part of the team who work on a different project, they have probably never gotten the memo of language choice to start with) or the documents are in some weird-ass combination of English-native which is even worse imo.
I really don't understand why my own team doesn't adhere to the decision though: we're all at least reasonably educated and our country focuses heavily on using English as second language so that should be no big barrier. And why would you want inconsistent documents/code?!
And this is not the first time people don't stick to what is decided for things like formats and language... Getting a bit tired of it tbh...5 -
So we're using Jira Wiki for all the documentation related work. It's hell rich with features as they describe. But for me easiest way is to write doc on markdown and then copy paste on Wiki. Highlights code, format tables and aligns paras perfectly.2
-
Confluence WYSIWYG-editor shall burn in a thousand hells. This thing pretends to be smart, yet all its autoformatting achieves is to enrage me. I don't remember dropping so many f-bombs in such a short time frame.
I hoped to ease to the pain by writing markdown, yet I can only write markdown in a new insert markup window which does not even comprehend nested lists. And don't get me started that it wants to push its Confluence Wiki syntax first. Why does it need to reinvent the wheel?
Why can't I disable the WYSIWYG feel of it and just write plain old markdown?
Confluence, you are part of the problem!
I rather keep the documetnation inside the git repostory inside of md files. But no, confluence shall be our source of soon to be outdated documentation.
Sigh. -
Damn, .NET devs are really and I mean really bad at writing documentation. It is either over-engineered (anything from Microsoft) to the point you can't find shit. Or it is almost non existent and you have to study the repo and read classes, etc. (ANY .net core nuget for writing CLI apps, heck I would argue almost any nuget in general)
4 pages on github WIKI + examples that cover 20% of use cases are not a bloody documentation mate!!!
I used to be linux + any of Python/Go/JS/Ruby/Elixir guy and almost never had problems with poor documentation.
Now living in Microsoft world with .net and powershell is terrifying.3 -
Client purchases platform from large tech company. Needs to be able to add custom CSS and JS. Spend weeks combing through sites looking for documentation. Compile my own from my own trial and error, a half ass wiki, and forums.
Client's platform is years out of date. -
#Suphle Rant 7: transphporm failure
In this issue, I'll be sharing observations about 3 topics.
First and most significant is that the brilliant SSR templating library I've eyed for so many years, even integrated as Suphle's presentation layer adapter, is virtually not functional. It only works for the trivial use case of outputting the value of a property in the dataset. For instance, when validation fails, preventing execution from reaching the controller, parsing fails without signifying what ordinance was being violated. I trim the stylesheet and it only works when outputting one of the values added by the validation handler. Meaning the missing keys it can't find from controller result is the culprit.
Even when I trimmed everything else for it to pass, the closing `</li>` tag seems to have been abducted.
I mail project owner explaining what I need his library for, no response. Chat one of the maintainers on Twitter, nothing. Since they have no forum, I find their Gitter chatroom, tag them and post my questions. Nothing. The only semblance of a documentation they have is the Github wiki. So, support is practically dead. Project last commit: 2020. It's disappointing that this is how my journey with them ends. There isn't even an alternative that shares the same philosophy. It's so sad to see how everybody is comfortable with PHP templating syntax and back end logic entagled within their markup.
Among all other templating libraries, Blade (which influenced my strong distaste for interspersing markup and PHP), seems to be the most popular. First admission: We're headed back to the Blade trenches, sadly.
2nd Topic: While writing tests yesterday, I had this weird feeling about something being off. I guess that's what code smell is. I was uncomfortable with the excessive amount of mocking wrappers I had to layer upon SUT before I can observe whether the HTML adapter receives expected markup file, when I can simply put a `var_dump` there. There's a black-box test for verifying the output but since the Transphporm headaches were causing it to fail, I tried going white-box. The mocking fixture was such a monstrosity, I imagined Sebastian Bergmann's ghost looking down in abhorrence over how much this Degenerate is perverting and butchering his creation.
I ultimately deleted the test travesty but it gave rise to the question of how properly designed system really is. Or, are certain things beyond testing white box? Are there still gaps in the testing knowledge of a supposed testing connoisseur? 2nd admission.
Lastly, randomly wanted to tweet an idea at Tomas Votruba. Visited his profile, only to see this https://twitter.com/PovilasKorop/.... Apparently, Laravel have implemented yet another feature previously only existing in Suphle (or at the libraries Arkitekt and Deptrac). I laughed mirthlessly as I watch them gain feature-parity under my nose, when Suphle is yet to be launched. I refuse to believe they're actually stalking Suphle3