I am using Electron for my web app but I want to create online documentation for the app rather than embedding the documentation within the app. The issue I have to deal with is the app's version number. As I release minor or major upgrades to the app, the documentation needs to reflect those changes. However, the person who is using app version 2.0 would see documentation that contains all the 1.0 stuff plus anything new that has been added in 2.0.
There are a number of ways of dealing with this. I could just have a link in the app to a url where each url is specific to a version. The downside to this is that I have to copy all the documentation from the 1.0 page to the 2.0 page and maintaining that could be a hassle.
Another approach is to just use one url but pass the version number in a query string and then hide/show those parts of the documentation that are relevant to their version.
If you've had to deal with this issue, what approach have you taken?
Related
i'm a mobile-develop engineer.work on IOS platform,using Xcode.
a few days ago.the man server developer has been changed in our company.he said the popular way of developed is using the template whose name was Restful API,then I was starting know something about the Restful api.
what i knew the thought of the template was the server need only developed the just the one http-interface.they didn't care whatever clients how to requested and how hardly used.
i didn't agree that, example in the page.the requirements is search friends depends on the text which user input on search-bar.
the 1.0 version is just searched the information which key included name.maybe we will send the requestPostDate=xx(which user inputed),filter=name.
the 2.0 version is searched the information which key included name、sex、age or your personal description.but I can't changed the requirements as soon as possible. because i have been wroten filter=name.
what should we did if it should changed in 1.0 versions on AppStore platform.
so what we did is modified the code which filter=name,sex,age. and upload the new library(IPA),then send it to AppStore.hope it's successful during these days.
what i need to say is if we not using restful api.we can be controlled by server.we just tell them we had a key which is xx,the clients didn't care about what the logic of how to search, it easier? and it changed quickly?the client didn't modified any code.maybe we have Web-platform、IOS-platform、android-platform.
i don't know what's the template your company using now.if it's restful api.please tell me how to fix about the questions what i said before?
the problem what i said is the restful api is suitable in IOS platform? maybe is suitable in Web platform,but not suitable in Mobile-developed-platform.
do you agree what i said? if not.give me some point which you think is right please.
Pretty straight forward question i think. I have created a web app in meteor and its using mongoDB storage. I have UI to update the data in the backend through the web app.
The question then becomes, I have designed an iOS app that i would really love for it to read the data being served to the web app from the mongoDB. As it stands, the app takes a url to a JSON file that i update regularly and serializes it accordingly. I want to pass on the tasks of updating the backend but exposing company employees to the potential mess of JSON backend, where missing/deleting a bracket / brace causes the app to break is out of the question.
My question is, since the meteor web app stores data as JSON documents, is there a way i can access the same JSON from the iOS app? It would really help because then, the person updating the backend only deals with UI, not code. I know this is a pretty broad question, but any pointers would be fantastic. Links, tutorials, frameworks to learn... anything. I've been googling around but can't seem to find anything solid.
Thanks!
You'll want to look into using one of the many iOS based DDP clients, like this one. With these libraries you can connect native iOS apps to the backend of any deployed Meteor app.
As far as I understand, you are looking for a way to get/update the data of your meteor server from the IOS app.
To do that, you can expose an API, like a REST one. Basically, your IOS app will call your Meteor server via HTTP and send/receive JSON data. Like that, you can get your collections, update, add, delete their items as well. There is a lot of literature around REST.
I used a very old one that I do not recommend because it is not maintained anymore, I will put the link anyway Old Rest API.
I invite you to have a look at atmosphere, the meteor package library: Atmosphere. I did a quick search on it and I found this package that looks promising: Simple Rest.
Have a look at the packages on Atmosphere, you can use 'rest' as keyword and pick the one that fits your needs. I am especially thinking of security ;).
I was wondering if anyone could point me to any useful tutorials on allowing a master user to update information for their app. I am looking into creating an application for a local restaurant and I want the owner to be able to update information like the soup of the day and such by themselves.
I have been looking into JSON and CMS for this, but I am unable to find any useful information regarding iOS 8 or xCode 6. If anyone could provide me with this information, or any other suggestions on how to achieve this I would be very grateful!
(I am using Swift not Objective-C)
This is not a code issue, rather it is a development concept issue. You have many choices including making an API that is updated by the restaurant. The app then connects to the API and gets the recipes. If you feel you need to do this via the App make a special username that is allowed access to modify the menu. This can be accomplished via matching username exactly or via using a regex. It all really depends on the structure of your app platform.
I am working GWT project which using History Class(com.google.gwt.user.client.History). Now the project work well. But the customer want the project run with unique url for security.
I tried to investigate the way to use the GWT History with a unique url but no luck.
If you know the solution, please give me the suggestion. Thank so much.
Well, the History implementation in GWT is based on hash fragments so if you remove that part (for instance overriding the nativeUpdate() method in HistoryImpl your app will never be notified when the state changes.
The solution I see is to override the History mechanism in GWT with your own based on the window.history.pushState() HTML5 API. It is supported by modern browsers (not IE9).
With push state you can change the state of the browser with and without changing the url.
There is an implementation of History based on pushState at gitHub. Johannes Barop gave a presentation of this project in the gwt-meetup 2013, videos are not avaliable yet (they will be in few days though). I think it does not implements your edge case of not changing the url, but probably it should be easy to add, or ask him at github.
Most sites are either fully released, or in beta.
But what happens if you have a large site, and some of the parts are still in Beta, and other parts aren't.
How do you effectively communicate this to the customer?
Maybe take a look at how Facebook, Bloglines, Gmail did it?
Like "We have this beta thing going on, come on over and see the same site with new stuff, but if it doesnt work, use the old parts"
Maybe gmail labs where you can sign up for "beta features"
If there's a certain way you enter the part of the beta site, maybe you can have a modal that pops up that they have to agree to every time. I wouldn't have it on every page since it gets annoying, so I would only use this approach if there is a definitive way to get into that part of the site (e.g. people won't be coming to random parts of the beta section through Google or something).
One way I've used for non-web software is a change to background. So for example if your normal site tended to have a plain white background, you could have the beta site have a repeating beta text in a background image. You want to make it fairly faint so it is present but doesn't detract from the overall experience.
Another subtle but present option would just be to change the title bar.
Or you could do what google does, which is a large site with some of it in beta. Check out Google experimental search. Basically the site is no different, but it is hard to get to accidentally.
There are a few ways.
Provide access to the site via two domains (e.g. www.domain.com and beta.domain.com) and only allow access to beta parts of the site when going in via beta.domain.com.
People will be accessing the same code base, but will only get access to the beta sections if they've specified the beta subdomain. Trying to access beta sections of the site will explain this & tell them how to access the beta.
Strongly Flag the beta sections of the application as being beta, and force the user to acknowledge that they're OK using beta features with some kind of agreement screen. The first time they try to use the beta feature, they'll be shown the agreement screen. Subsequent uses of the feature will prominently deisplay that "thios part of the site is in beta and is used at your own peril."