Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 5 years ago.
Improve this question
I've recently moved my project from sourceforge to Google code. I'm intrigued by the Google code wiki that is integrated with svn, but I'm not sure of the best way to use it to provide project documentation.
For my project, documentation could appear in three places: (1) on the wiki, (2) in the desktop application I'm developing (using wxPython), and (3) on the project website (which is http://www.openstv.org and is Drupal based).
I like the idea of using the Google code wiki as the primary source of the documentation, and then automatically incorporating this documentation in both the desktop application and on the project website .
Does anyone have any suggestions for doing this?
The Wiki files live in Subversion -- just svn checkout http://yourproject.googlecode.com/svn/wiki yourwiki and you get a yourwiki SVN repository that's easy to keep updated (just svn up in it once in a while, e.g. in a crontab).
The format of the Wiki files is a Google variant of ReSTructured Text so you could write scripts to convert it to plain ReST and from there to whatever other formats you prefer for your other uses -- or, write ReST on your system, convert it to whatever you like (including perhaps Google's wiki format;-), and upload that...
Related
Closed. This question needs to be more focused. It is not currently accepting answers.
Want to improve this question? Update the question so it focuses on one problem only by editing this post.
Closed 4 years ago.
Improve this question
I'm working on a webshop. And would like to add the feature to be able to post product images to the shops Instagram account when a new product is added.
The thing is that the Instagram API does not seems to allow to post images. Either does the official Instagram Website. And a Google Search gives me multiple SO QA which says the same.
But at the same time, there seems to be a ton of websites, applications, and services and other non-emulators who let you post to Instagram (to mention a few: http://techwiser.com/effectivly-use-instagram-on-pc-upload-pics-bluestacks/ and http://dskgrm.com/ is another one, there also seems to be some WordPress plugins who does it ex. https://github.com/roladn/wordpress-to-instagram but I'm not too good with eirhet PHP or WordPress to be able to tell how they have done it.).
And before anyone reports it as a duplicate. I do not consider this a duplicate since all other QA simply states that it is not possible via the API, but obviously, it is possible somehow, and I'm wondering how.
So I simply wondering how people are successfully implementing this feature when either the API or the official website allows it?
No official way to post media to Instagram doesn't mean that there is no way to do this.
If you are a developer you could simply reverse engineering the Instagram API and build some software to use that, otherwise you could just use some tools already developed.
PHP
mgp25/Instagram-API
Python
b3nab/instapy-cli
And if this don't fit your needs you can go to github and search some other softwares already developed.
Closed. This question needs to be more focused. It is not currently accepting answers.
Want to improve this question? Update the question so it focuses on one problem only by editing this post.
Closed 7 years ago.
Improve this question
Can anyone give advice, or point to any guides, on how to manage a community of open source software developers in writing api documentation?
A typical, unmanaged, starting point for most projects is to have a project wiki where anyone can freely create pages, add content to existing pages, edit existing content etc. The problem is that, despite people's best intentions, the wiki can easily end up being a disorganised, poorly written, incomplete, written in disparate voices etc etc.
So, what to do to improve the quality of the documentation?
I suspect a key ingredient is clear editorial/style guidelines, something similar to http://en.wikipedia.org/wiki/Wikipedia:Encyclopedic_style#Information_style_and_tone. Can anyone point to an example of such a guide tailored specifically to software apis?
Are there any other practices that people have found useful? E.g. form a core team of editors and accept that most documentation that gets added by the community will most likely need to be 'strongly edited'?
The short answer, that the solution is social/human and not technical. The way to get good documentation for any project is to have someone with time, in charge of doing high level organization for the documentation, and then being involved in the development and user communities to ensure that the documentation remains up to date and continues to address the problems and confusions that users typically have.
Community projects have accepted that you need point people (i.e. "managers," for aspects of the project like "translation," and "release," and for various components. The same thing needs to happen for documentation.
As for tools, Sphinx is really great though it's not "wiki like," exactly you can use whatever version control system your project is comfortable with to store documentation and configure your web server to rebuild the documentation following commits/updates/pushes. Which has always worked just fine for any project I've worked on/with.
Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 5 years ago.
Improve this question
I'd like to write an architecture document for a little ruby project I'm working on, and being an architecture document it'll benefit from a few box and stick diagrams.
What's the done thing on open source projects for this situation? Should I be practicing my ASCII art, or should I include PDFs or something in my doc folder?
Note that this is a stand-alone document, not API documentation generated from the code.
Check out umlet-github, a Google Chrome extension that allows you to create diagrams in UMLet, store them as UXF files in your repository and view them in your browser within the GitHub interface.
I would say use Gliffy, where you can export diagrams to .JPG or .PDF and attach them to your README.md file.
You can also get a sharable link and include it in there. Very handy.
Closed. This question is off-topic. It is not currently accepting answers.
Want to improve this question? Update the question so it's on-topic for Stack Overflow.
Closed 11 years ago.
Improve this question
I came across this erlang doc repository on bitbucket.org through a google search, and I don't understand where it came from:
http://docs.bitbucket.org/erlang_otp/index.html
Is this just a copy of some official erlang docs? If so, where can I find the original index page on Erlang.com's site? This bitbucket page is a lot more comprehensive and easier to get a bird's eye view of what's available than the top level doc pages on erlang.org, e.g., http://www.erlang.org/doc/.
If it's a bitbucket-only thing, what's the initiative that causes it to be on bitbucket? Does bitbucket host developer documentation or some such? I couldn't google up a reference to any such feature.
It's a copy of the Erlang documentation for version R13B02 (a quite old and outdated version). It seems to be compiled with PyDoc.
There are today two good sources for Erlang documentation:
http://www.erlang.org/doc - This one is always the most up to date
http://erldocs.com - Easier to search, but doesn't have the user guides
the bit bucket erlang docs have fascinated me too. However, the original docs are here: http://www.erlang.org/doc/. The whole documentation is found here: http://www.erlang.org/doc.html.
The one at bit bucket seems its their own arrangement similar to python 3.2.1 docs. Its the same copy as the original, just in a better arrangement (perhaps), to them. Everything is accessible and its a better guide to some one who is just starting with the language. I like their arrangement.
Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 4 years ago.
Improve this question
Неllо. I develop system that works with stock exchange(system, below). And there is a lot of information my program need to interact with this system. This system has formal declared interface, but different details beside this declaration and requirements to my system is often changed. So how can I organize available information about this system and requirements to my program that it could be both easy to understand and easy to change.
Your first and foremost goal is to create documentation for the relevant APIs your program exposes and then add documentation for the configuration files, maybe even set up a validator for configuration that.
Automatically generated content from code annotations (depending on your solution, it might be .NET's XML docs or PHPdoc, etc.) is the first step – this will help you document classes and interfaces as you work on the code. The next step is documenting non-code assets. If you have XML configuration, you can write schemas to validate against, for example.
After that comes integration documentation – steps that need to be taken on the production server and/or workstations to install, upgrade and maintain the application, including support scripts.