Re: Royale in 10 minutes (was Re: Proposed table of contents for Royale help documentation)

; >><yishayj...@hotmail.com> > >> >> wrote: > >> >> > >> >> > This looks very promising. I’m going to read this in batches. Some > >> >> > feedback on ‘The data model’. > >> >> > > >> >> &g

Re: Royale in 10 minutes (was Re: Proposed table of contents for Royale help documentation)

> >> > repos = configurator.data.repos; >> >> > projectName = configurator.data.projectName; >> >> > >> >> > Shouldn’t these be cast to a String and an Array respectively? >> >> > >> >> > Also,

Re: Royale in 10 minutes (was Re: Proposed table of contents for Royale help documentation)

>> > projectName = configurator.data.projectName; > >> > > >> > Shouldn’t these be cast to a String and an Array respectively? > >> > > >> > Also, I find these lines a bit misleading > >> > > >> > > >> > > >&

Re: Royale in 10 minutes (was Re: Proposed table of contents for Royale help documentation)

>>Since some of the viewers will be first timers I think it’s important to >>put code in script blocks. >That's up to Andrew. He's our "editor-in-chief". Argh! But, yes, code should usually be in script blocks. I will go look at the specific page. On Wed, Jan 31, 2018 at 12:16 PM, Alex Harui

Re: Royale in 10 minutes (was Re: Proposed table of contents for Royale help documentation)

Also, I find these lines a bit misleading >> > >> > >> > >> > >> > import org.apache.royale.events.Event; >> > >> > >> > Since some of the viewers will be first timers I think it’s important >>to >> > put code i

Re: Royale in 10 minutes (was Re: Proposed table of contents for Royale help documentation)

v8k8Itgxne4cdi8W%2F5mqQtZkg9MWsBviM%3D=0> >>> >>> ________ >>> From: Alex Harui >>> Sent: Tuesday, January 30, 2018 10:49:58 PM >>> To: dev@royale.apache.org >>> Subject: Re: Royale in 10 minutes (was Re: Proposed

RE: Royale in 10 minutes (was Re: Proposed table of contents for Royale help documentation)

LID> Sent: Wednesday, January 31, 2018 8:50 AM To: dev@royale.apache.org<mailto:dev@royale.apache.org> Subject: Re: Royale in 10 minutes (was Re: Proposed table of contents for Royale help documentation) Hi, I've pushed what I will call a first draft of the main portion of a tutorial for

Re: Royale in 10 minutes (was Re: Proposed table of contents for Royale help documentation)

table of contents for Royale help documentation) Hi, I've pushed what I will call a first draft of the main portion of a tutorial for using Royale. See: http://apacheroyaleci.westus2.cloudapp.azure.com:8080/job/RoyaleDocs_Stagin g/lastSuccessfulBuild/artifact/_site/create-an-application/applicatio

Re: Royale in 10 minutes (was Re: Proposed table of contents for Royale help documentation)

Hi, I've pushed what I will call a first draft of the main portion of a tutorial for using Royale. See: http://apacheroyaleci.westus2.cloudapp.azure.com:8080/job/RoyaleDocs_Stagin g/lastSuccessfulBuild/artifact/_site/create-an-application/application-tuto rial.html Feedback welcome. Looks

Re: Royale in 10 minutes (was Re: Proposed table of contents for Royale help documentation)

On 1/26/18, 11:43 AM, "Andrew Wetmore" wrote: >I don't think we need to build out the full ToC up front, rather than PAYG >haha. There are tons of pages that I have not yet listed in the Google >doc, >and several decisions we have to make. > >For example, we have an

Re: Royale in 10 minutes (was Re: Proposed table of contents for Royale help documentation)

I don't think we need to build out the full ToC up front, rather than PAYG haha. There are tons of pages that I have not yet listed in the Google doc, and several decisions we have to make. For example, we have an Express set of controls and MDL and who knows what else. I presume we need to

Re: Proposed table of contents for Royale help documentation

I'll try that route and see what I get. I'll be back with my results. 2018-01-26 3:15 GMT+01:00 Alex Harui : > Hi Carlos, > > I don't know how big the changes you are thinking of and how much time you > have, but you could mock up something in your WP instance or post

Re: Royale in 10 minutes (was Re: Proposed table of contents for Royale help documentation)

Hi Andrew, Responses in-line. On 1/26/18, 2:48 AM, "Andrew Wetmore" wrote: >Good morning. > >Least thing first: Does the Apache header absolutely need to be in short >lines with hard line breaks so it takes up so much vertical space in the >file? Please look at

Re: Royale in 10 minutes (was Re: Proposed table of contents for Royale help documentation)

Good morning. Least thing first: Does the Apache header absolutely need to be in short lines with hard line breaks so it takes up so much vertical space in the file? Please look at test-apache-header.md and see whether the header laid out on fewer lines and trusting to line wrapping works. I am

Re: Royale in 10 minutes (was Re: Proposed table of contents for Royale help documentation)

Hi Andrew, I took a quick peek at the Adobe doc. I'm not sure "Development Phases" should be the first thing under "Create an application", especially given how the Adobe doc says that some of those sub-topics are not phases. Also, I think there is more than one way to develop an application.

Re: Proposed table of contents for Royale help documentation

Hi Carlos, I don't know how big the changes you are thinking of and how much time you have, but you could mock up something in your WP instance or post an image and I could try to make the changes in the current template. Let me know, -Alex On 1/25/18, 4:17 PM, "carlos.rov...@gmail.com on

Re: Proposed table of contents for Royale help documentation

Hi Alex, getting up with the last day info. Right, I'll try this week-end to make something that looks good. First I have to figure how to work taking into account the other threads I read and the way you guys are working. Thanks 2018-01-25 0:23 GMT+01:00 Alex Harui :

Re: Royale in 10 minutes (was Re: Proposed table of contents for Royale help documentation)

Hi: I think the "Royale in 10 Minutes" goes where the ToC "Hello, World!" is in the "Get Started" section. I saw the "Create an Application" section as what you would turn to when you had gone through building a first little application and decided, yes, maybe this Royale is the thing I need for

Royale in 10 minutes (was Re: Proposed table of contents for Royale help documentation)

Hi Andrew, So I just pushed more stubs for the Create An Application section. As I was doing so, I started thinking that what you expect in that section is different from what I'm interested in working on. It isn't that we don't need that section, but it appears that you want to address

Re: Proposed table of contents for Royale help documentation

MIT is fine, as is BSD. But again, if the theme has many parts, it may result in the PMC spending time researching each of the parts. Just because the theme author claims MIT for his work, he might have used third-party works under other licenses that aren't as compatible with the Apache

Re: Proposed table of contents for Royale help documentation

Hi Alex, right, I'm looking for something that is ALv2. Unfortunately almost all docs themes are MIT license. Is MIT right for us? 2018-01-24 18:14 GMT+01:00 Alex Harui : > Hi Carlos, > > Right now, the master branch is set up to use the Cayman theme. When I > took a

Re: Proposed table of contents for Royale help documentation

Hi Carlos, Right now, the master branch is set up to use the Cayman theme. When I took a quick look at Cayman, it appeared to be under Creative Commons, which makes it very difficult for us to use. Unfortunately, just because it is "Open Source" and on GitHub doesn't mean it is compatible with

Re: Proposed table of contents for Royale help documentation

I am even rewriting the legacy Apache Flex stuff I think we can reuse. Apart from issues of licenses, I don't want to trample on other writers by stealing, as opposing to learning from, their material. On Wed, Jan 24, 2018 at 12:07 PM, Alex Harui wrote: > Again, please

Re: Proposed table of contents for Royale help documentation

Again, please be careful when copying anything you find on the internet. I still think we want to make our doc licensed under the Apache License and lots of web stuff is Creative Commons. The "best" stuff may be under copyrights and other licenses and require attributions that make more work for

Re: Proposed table of contents for Royale help documentation

Right, when I planned the website, I was learning as well from that websites and apache websites, and copying, mixing from here and there was how I did the current one. I think we should take the test of those for our docs to get the best we can. thanks! :) 2018-01-24 12:35 GMT+01:00 Andrew

Re: Proposed table of contents for Royale help documentation

Thanks for the pointer about the React and Angular sites, Carlos. Lots to learn from! -- Andrew Wetmore http://cottage14.blogspot.com/

Re: Proposed table of contents for Royale help documentation

Great Andrew! :))) 2018-01-24 12:33 GMT+01:00 Andrew Wetmore : > Hi! > > Yes, I feel like a real committer now. > > I am going to migrate some material from the FlexJS documentation to see > what that experience is like. I am going to draw from "Overview" [1] >

Re: Proposed table of contents for Royale help documentation

Hi! Yes, I feel like a real committer now. I am going to migrate some material from the FlexJS documentation to see what that experience is like. I am going to draw from "Overview" [1] to populate both "High level view"

Re: Proposed table of contents for Royale help documentation

Hi Alex, for this reason is better to go with a OS GitHub theme that only needs to use the colors, fonts and logos from our website. Those where selected by me and are not provided by the WP theme. The other main reason is that we need to use something done for that task with the maximum quality.

Re: Proposed table of contents for Royale help documentation

Personally, I would be very cautious about WP themes or copying look-and-feel of other sites. I would like our doc to be license-able under ALv2 and not run into IP and licensing issues. -Alex On 1/23/18, 3:11 PM, "carlos.rov...@gmail.com on behalf of Carlos Rovira"

Re: Proposed table of contents for Royale help documentation

Hi, I tried to read through this thread, but many mails to catch all whats happening at the moment, and just want to say a couple of things: 1.- Regarding TOC, I think it's ok (in a quick review, I should work a bit on docs too to see how this works). But as anything, I assume that it's a

Re: Proposed table of contents for Royale help documentation

I have set up 2FA and presume I have to wait a while until GitHub notices. In the mean time I may create another page or two offline... On Tue, Jan 23, 2018 at 4:41 PM, Andrew Wetmore wrote: > I have requested my authentication code, but it seems to be slow >

Re: Proposed table of contents for Royale help documentation

I have requested my authentication code, but it seems to be slow arriving...Will wait. On Tue, Jan 23, 2018 at 4:28 PM, Alex Harui wrote: > Hi Andrew, > > Infra did more checking and says that you haven't enabled 2FA on GH which > is why you are being denied. The links

Re: Proposed table of contents for Royale help documentation

Hi Andrew, Infra did more checking and says that you haven't enabled 2FA on GH which is why you are being denied. The links below may help you do that. https://help.github.com/articles/securing-your-account-with-two-factor-auth entication-2fa/

Re: Proposed table of contents for Royale help documentation

Not a tremendously helpful note, in that if I follow the link about permissions it takes me to vague observations and no actionable information. On Tue, Jan 23, 2018 at 4:14 PM, Andrew Wetmore wrote: > When I follow that process and get to the merge point, GitHub tells me

Re: Proposed table of contents for Royale help documentation

When I follow that process and get to the merge point, GitHub tells me I do not have write permissions to the 'develop' branch. On Tue, Jan 23, 2018 at 4:12 PM, OmPrakash Muppirala wrote: > A good workflow would be as follows: > > * Create your personal branch off of the

Re: Proposed table of contents for Royale help documentation

A good workflow would be as follows: * Create your personal branch off of the `develop` branch * Make all your commits directly to your personal branch * When you are ready to share your work to the world, create a Pull Request from your branch to `develop` * This will let others look at and

Re: Proposed table of contents for Royale help documentation

Hi Andrew, I've never used the GH UI before. If there is a way to merge your pull requests via the UI, then you should commit them that way once we figure out why you are having permissions issues. Otherwise, it is time to use Git and clone the repo and figure out how to pull/commit/push. I

Re: Proposed table of contents for Royale help documentation

Ah, wait: I was only creating and editing that file in my personal branch. I still don't see how to do creates and edits without making and having someone else process branches. On Tue, Jan 23, 2018 at 3:50 PM, Andrew Wetmore wrote: > I now seem to be able to create and

Re: Proposed table of contents for Royale help documentation

I now seem to be able to create and commit a new file, and to edit an existing file and commit the edited file directly! Excellent. What do I do with the lurking pull requests? -- Andrew Wetmore http://cottage14.blogspot.com/

Re: Proposed table of contents for Royale help documentation

On Tue, Jan 23, 2018 at 11:35 AM, Alex Harui wrote: > Can you use Git to clone a repo and try a test commit? That might help > determine if the problem is that your committer rights are still not right > or just the rights to use the GH UI (which does allow me to use

Re: Proposed table of contents for Royale help documentation

Can you use Git to clone a repo and try a test commit? That might help determine if the problem is that your committer rights are still not right or just the rights to use the GH UI (which does allow me to use the edit button). -Alex On 1/23/18, 11:22 AM, "Andrew Wetmore"

Re: Proposed table of contents for Royale help documentation

On Tue, Jan 23, 2018 at 11:22 AM, Andrew Wetmore wrote: > I have logged out of GitHub and logged back in on the browser. GitHub > congratulates me for having joined Apache, and shows me the repositories I > am involved in, including royale-docs. I don't see any reference to

Re: Proposed table of contents for Royale help documentation

I have logged out of GitHub and logged back in on the browser. GitHub congratulates me for having joined Apache, and shows me the repositories I am involved in, including royale-docs. I don't see any reference to my permissions or how to change them. On Tue, Jan 23, 2018 at 3:13 PM, Andrew

Re: Proposed table of contents for Royale help documentation

I got this message from GitHub after I went through the steps you provided: You’ve been added to the Apache Committers team for the The Apache Software Foundation organization. Apache Committers has 1754 members and gives *pull* access to 1 apache repository. View Apache Committers:

Re: Proposed table of contents for Royale help documentation

GitHub tells me I don't have write permissions to the repository when I am editing a file, and I don't know what step to take to obtain those permissions. On Tue, Jan 23, 2018 at 2:05 PM, Alex Harui wrote: > Hi Andrew, > > You shouldn't have to open Pull Requests any

Re: Proposed table of contents for Royale help documentation

Hi Andrew, You shouldn't have to open Pull Requests any more. You should be able to directly commit/push to the source and edit the wiki. Let us know if you are having problems getting that to work. -Alex On 1/23/18, 10:00 AM, "Andrew Wetmore" wrote: >Thanks! I will be

Re: Proposed table of contents for Royale help documentation

Thanks! I will be using that shortly. On Tue, Jan 23, 2018 at 1:02 PM, Nemi wrote: > Andrew, you can create a folder on github.com same way as you create file, > just type like "newFolder/newFile". When you have typed "/" github will > recognize it as a folder. > > > > -- >

Re: Proposed table of contents for Royale help documentation

Andrew, you can create a folder on github.com same way as you create file, just type like "newFolder/newFile". When you have typed "/" github will recognize it as a folder. -- Sent from: http://apache-royale-development.20373.n8.nabble.com/

Re: Proposed table of contents for Royale help documentation

Ahh ok you are editing only md files, that's why you are using GitHub straightforward. You can also checkout git repository and make edition locally on your PC. Maybe it would be better even for you. I see for example that Visual Studio Code have Mark Down helper editor [1] To commiting/pushing

Re: Proposed table of contents for Royale help documentation

Hi, Piotr: I was not aware that an intermediary tool was available. I am just glaring straight at Github: https://github.com/apache/royale-docs/tree/develop/Welcome/Features On Mon, Jan 22, 2018 at 4:42 PM, Piotr Zarzycki wrote: > Andrew, > > What application are you

Re: Proposed table of contents for Royale help documentation

If you are asking about using folders with index.html pages Jekyll can do the too, I think. -Alex On 1/22/18, 11:30 AM, "Alex Harui" wrote: >Yes. Jekyll takes the .MD files and creates a folder _site with the same >folder structure, but with HTML instead of MD. The

Re: Proposed table of contents for Royale help documentation

So...all the entries in the doc ToC point to .html locations. Are we creating .md pages that automagically convert? Where do we put them in the file structure? On Mon, Jan 22, 2018 at 3:15 PM, Andrew Wetmore wrote: > And there we are! > > On Mon, Jan 22, 2018 at 3:12 PM,

Re: Proposed table of contents for Royale help documentation

And there we are! On Mon, Jan 22, 2018 at 3:12 PM, OmPrakash Muppirala wrote: > I believe you need to switch to the `develop` branch. > > Thanks, > Om > > On Mon, Jan 22, 2018 at 11:11 AM, Andrew Wetmore > wrote: > > > I do not see anything there that

Re: Proposed table of contents for Royale help documentation

I believe you need to switch to the `develop` branch. Thanks, Om On Mon, Jan 22, 2018 at 11:11 AM, Andrew Wetmore wrote: > I do not see anything there that relates to the demo you did showing the > ToC for the help documentation. I see two .md pages, just placeholders. >

Re: Proposed table of contents for Royale help documentation

I do not see anything there that relates to the demo you did showing the ToC for the help documentation. I see two .md pages, just placeholders. docpage.html in _layouts seems to just be the code for the Royale main page. On Mon, Jan 22, 2018 at 3:06 PM, Alex Harui

Re: Proposed table of contents for Royale help documentation

Here it is again. Github Project: https://github.com/apache/royale-docs Clone URL: https://github.com/apache/royale-docs.git HTH, -Alex On 1/22/18, 11:02 AM, "Andrew Wetmore" wrote: >Sorry to be so dense, but I do not see where to find the documentation >project so I can

Re: Proposed table of contents for Royale help documentation

Sorry to be so dense, but I do not see where to find the documentation project so I can add pages, edit pages, or update the ToC. The links in Alex's most recent post do not seem to work for me, even when I edit out the errant "_" that I think my email client inserted at the line break. --

Re: Proposed table of contents for Royale help documentation

I believe approval of my committer status is in process, but not complete. When it is complete, do I get access to Jenkins, or do I go ahead and create a login for myself? And, once I have that, is it clear how to work with Jenkins? Or am I off to tutorial-land? On Mon, Jan 22, 2018 at 5:24 AM,

Re: Proposed table of contents for Royale help documentation

OK, I will look into how to do that. I've pushed enough changes so that you can see the beginnings of a TOC for some of the pages. Committers are welcome to grab the develop branch, make the TOC look better, create and fill in the missing pages, etc. Hopefully you can see the pattern of what

Re: Proposed table of contents for Royale help documentation

Some of the inherited stuff in subversion may be quite useful, although not in the first wave of populating the help docs. I see stuff on internationalization, for instance, that I don't think we are touching yet in Royale. Going back to questions about helping people start quickly with Royale, I

Re: Proposed table of contents for Royale help documentation

The Flex doc is in a branch in Subversion. You can browse it here: http://svn.apache.org/viewvc/flex/site/branches/flexdoc/content/doc/flex/us ing/ I think you can use Subversion and clone this: https://svn.apache.org/repos/asf/flex/site And find it in the branches. Donations are really

Re: Proposed table of contents for Royale help documentation

It seems to me that there will be a period of heavy lifting as we populate the help docs for the first time, and that then the load will diminish significantly. I am happy to contemplate updating the ToC by hand a couple of times a week indefinitely: small pain for big gain. I would love to

Re: Proposed table of contents for Royale help documentation

I've been wondering if it was worth trying to autogenerate the TOC or not. The only advantage is that it would allow us to add a page and have it appear without having to also edit the template. I think I'll give up on auto-generating the TOC. BTW, in 2015, Adobe donated some Flex doc to

Re: Proposed table of contents for Royale help documentation

I feel like we are trying to fit ourselves to the limitations of a template, rather than setting up to do what will present the material in the best way. I am almost positive that we will have collections of pages that we can't even anticipate now, but for sure "Flex in a Week" is a great example.

Re: Proposed table of contents for Royale help documentation

I've spent the afternoon reading Jekyll doc. Jekyll has a concept of "Collections" that could be used to help auto-generate a TOC, but if there is a "Welcome" collection (and a "Get Started" and "Create An Application" and other collections for each top-level), the collection pages will be at

Re: Proposed table of contents for Royale help documentation

>I assume that the Welcome page is the main index.html landing page? Maybe on its content it will lead you more towards the Get Started page. Yes and yes. On Fri, Jan 19, 2018 at 4:40 PM, Alex Harui wrote: > OK, we'll leave it as you have it and see what kind of

Re: Proposed table of contents for Royale help documentation

OK, we'll leave it as you have it and see what kind of feedback we get. I assume that the Welcome page is the main index.html landing page? Maybe on its content it will lead you more towards the Get Started page. -Alex On 1/19/18, 9:36 AM, "Andrew Wetmore" wrote: >I am

Re: Proposed table of contents for Royale help documentation

I am not sure I agree about putting "Getting Started" first. If the table of contents as I propose it appears with its top-level entries collapsed, then "Get started" is the second item the reader sees. I do not think that is too big of a hurdle to jump over. On Fri, Jan 19, 2018 at 1:19 PM, Alex

Re: Proposed table of contents for Royale help documentation

Hi Andrew, Thanks for doing this. I'm wondering if we should have a "Getting Started" before "Features and Concepts". I would like to see us emphasize the Express components more going forward, which may reduce the emphasis on PAYG for the newbie. PAYG is important to the framework developers

Proposed table of contents for Royale help documentation

Hi, all: I have started to outline the sort of table of contents for Royale user documentation that I as a non-expert developer would want to see. I would want the ToC to lead me to information that will help me both migrate existing Flex projects to Royale and create new projects within the