[Script Info]
Title: 
[Events]
Format: Layer, Start, End, Style, Name, MarginL, MarginR, MarginV, Effect, Text
Dialogue: 0,0:00:02.78,0:00:05.90,Default,,0000,0000,0000,,Hey there this is Mark, founder of modmore
Dialogue: 0,0:00:05.90,0:00:10.36,Default,,0000,0000,0000,,and in this video I'm going to quickly show how you can help with editing the new MODX documentation
Dialogue: 0,0:00:11.47,0:00:13.53,Default,,0000,0000,0000,,First things first, this is the documentation
Dialogue: 0,0:00:13.53,0:00:14.46,Default,,0000,0000,0000,,I'm referring to
Dialogue: 0,0:00:14.84,0:00:17.16,Default,,0000,0000,0000,,which is currently available on docs.modx.org
Dialogue: 0,0:00:17.96,0:00:21.66,Default,,0000,0000,0000,,which is different from the version that\Nruns on docs.modx.com
Dialogue: 0,0:00:22.62,0:00:26.63,Default,,0000,0000,0000,,it's basically a community project we've\Nbeen working on
Dialogue: 0,0:00:26.63,0:00:29.71,Default,,0000,0000,0000,,to convert the documentation to the\Nmarkdown format
Dialogue: 0,0:00:29.71,0:00:33.61,Default,,0000,0000,0000,,and hosting those on github to allow\Nopen and transparent collaboration
Dialogue: 0,0:00:33.61,0:00:35.55,Default,,0000,0000,0000,,to make it better
Dialogue: 0,0:00:36.29,0:00:41.08,Default,,0000,0000,0000,,it's still under active development, so\Nif you watch this later you may notice\Nsome things have changed
Dialogue: 0,0:00:41.08,0:00:43.27,Default,,0000,0000,0000,,in the design or overall structure
Dialogue: 0,0:00:43.27,0:00:46.28,Default,,0000,0000,0000,,but this is basically what we're looking\Nat today
Dialogue: 0,0:00:48.06,0:00:52.24,Default,,0000,0000,0000,,so let's see how this works, how we can\Nmake a change to this documentation
Dialogue: 0,0:00:52.52,0:00:55.74,Default,,0000,0000,0000,,let's say we were browsing the extras
Dialogue: 0,0:00:55.74,0:00:59.06,Default,,0000,0000,0000,,and we were looking at the\NaddHeaderfiles snippet
Dialogue: 0,0:01:00.09,0:01:03.84,Default,,0000,0000,0000,,and we noticed that this table here\Ndoesn't look right
Dialogue: 0,0:01:04.60,0:01:08.03,Default,,0000,0000,0000,,the first column is missing, it seems to\Nhave shifted
Dialogue: 0,0:01:08.03,0:01:11.27,Default,,0000,0000,0000,,and this is actually a result of the\Nconversion which happened
Dialogue: 0,0:01:11.27,0:01:14.85,Default,,0000,0000,0000,,on some pages which we can\Nquite easily fix
Dialogue: 0,0:01:16.15,0:01:23.64,Default,,0000,0000,0000,,to do that we'll find the "Edit this page"\Nlink which is located both here in the\Ntitle as well as in the footer
Dialogue: 0,0:01:23.64,0:01:27.45,Default,,0000,0000,0000,,and this will open a new page on github
Dialogue: 0,0:01:29.12,0:01:33.76,Default,,0000,0000,0000,,You do need a github account, which is\Nfree if you don't already have one
Dialogue: 0,0:01:33.76,0:01:37.57,Default,,0000,0000,0000,,and I'll just login as my test account
Dialogue: 0,0:01:37.57,0:01:42.36,Default,,0000,0000,0000,,just so it's the same way it will be for\Nyou the first time you edit something
Dialogue: 0,0:01:44.19,0:01:48.08,Default,,0000,0000,0000,,So the first thing it asks me for is to\Nfork the repository.
Dialogue: 0,0:01:48.08,0:01:52.47,Default,,0000,0000,0000,,If you're not familiar with how git or git\Nflow and all that works, no worries.
Dialogue: 0,0:01:52.47,0:01:57.76,Default,,0000,0000,0000,,Just click the green button which\Nwill basically make a copy of the
Dialogue: 0,0:01:57.76,0:02:00.58,Default,,0000,0000,0000,,official documentation that you can make\Nchanges to directly.
Dialogue: 0,0:02:01.94,0:02:07.40,Default,,0000,0000,0000,,The official version, which is under the\Nmodxorg name, not everyone can change
Dialogue: 0,0:02:07.40,0:02:11.85,Default,,0000,0000,0000,,that directly, so forking is the way to\Nstart making changes.
Dialogue: 0,0:02:12.67,0:02:14.57,Default,,0000,0000,0000,,So I'll fork it.
Dialogue: 0,0:02:15.27,0:02:17.89,Default,,0000,0000,0000,,Which will land us in the edit view.
Dialogue: 0,0:02:18.76,0:02:24.97,Default,,0000,0000,0000,,It immediately sends us to the right page,\Nthe addHeaderfiles extra.
Dialogue: 0,0:02:25.72,0:02:29.76,Default,,0000,0000,0000,,We can now look at what happened with\Nthat table.
Dialogue: 0,0:02:30.05,0:02:34.25,Default,,0000,0000,0000,,So this is roughly how a table is managed\Nin markdown.
Dialogue: 0,0:02:34.82,0:02:36.57,Default,,0000,0000,0000,,There are these pipe symbols (|)
Dialogue: 0,0:02:36.57,0:02:39.05,Default,,0000,0000,0000,,and then there's content in the cell
Dialogue: 0,0:02:39.05,0:02:40.88,Default,,0000,0000,0000,,another pipe symbol, more content
Dialogue: 0,0:02:42.63,0:02:45.87,Default,,0000,0000,0000,,this is basically the separation between\Nthe header and the body of a table
Dialogue: 0,0:02:46.89,0:02:48.12,Default,,0000,0000,0000,,and then there's the rest
Dialogue: 0,0:02:49.47,0:02:52.94,Default,,0000,0000,0000,,so the problem here is actually,\Nmay be a bit hard to see
Dialogue: 0,0:02:52.94,0:02:56.38,Default,,0000,0000,0000,,but there's a space before each line\Nof the table
Dialogue: 0,0:02:56.70,0:02:58.52,Default,,0000,0000,0000,,that's causing it to not get rendered\Nproperly
Dialogue: 0,0:02:59.07,0:03:03.49,Default,,0000,0000,0000,,so what i'll do is, I'll just select\Nall the lines and do a shift-tab
Dialogue: 0,0:03:04.16,0:03:07.54,Default,,0000,0000,0000,,which puts everything nicely in the\Nright place
Dialogue: 0,0:03:09.08,0:03:11.57,Default,,0000,0000,0000,,and while we're at it, we could also make\Nother changes
Dialogue: 0,0:03:11.57,0:03:14.36,Default,,0000,0000,0000,,I mean we could check the content, is it\Nwritten properly?
Dialogue: 0,0:03:14.36,0:03:17.20,Default,,0000,0000,0000,,maybe there are some formatting issues?
Dialogue: 0,0:03:17.93,0:03:22.68,Default,,0000,0000,0000,,I guess there's some code here that should\Nbe wrapped in these little quotes
Dialogue: 0,0:03:22.98,0:03:26.29,Default,,0000,0000,0000,,to make sure they're formatted as code\Nas well
Dialogue: 0,0:03:26.71,0:03:30.98,Default,,0000,0000,0000,,so basically you can edit the entire page\Ncontent just from this view
Dialogue: 0,0:03:32.94,0:03:35.94,Default,,0000,0000,0000,,When you're happy with this, you need to\Nsave the changes.
Dialogue: 0,0:03:35.94,0:03:38.30,Default,,0000,0000,0000,,That's called a "commit" in git terms.
Dialogue: 0,0:03:38.30,0:03:42.29,Default,,0000,0000,0000,,But you can do that just from the bottom\Nhere where it says "Propose file change"
Dialogue: 0,0:03:42.82,0:03:50.82,Default,,0000,0000,0000,,So we can say "fix formatting issues on\NaddHeaderFiles page"
Dialogue: 0,0:03:52.10,0:03:54.76,Default,,0000,0000,0000,,You can add an additional description here\Nbut that's not necessary
Dialogue: 0,0:03:55.22,0:03:58.09,Default,,0000,0000,0000,,We'll click the green button to propose\Nthe file change
Dialogue: 0,0:04:00.94,0:04:05.34,Default,,0000,0000,0000,,That sends us into a view where we can\Ncompare the changes we made
Dialogue: 0,0:04:05.34,0:04:06.96,Default,,0000,0000,0000,,to the official version.
Dialogue: 0,0:04:07.98,0:04:14.04,Default,,0000,0000,0000,,So we can see here the base repository\Nis Docs under modxorg, and ours is
Dialogue: 0,0:04:14.04,0:04:18.20,Default,,0000,0000,0000,,Mark-H2 with a certain branch name
Dialogue: 0,0:04:19.52,0:04:23.65,Default,,0000,0000,0000,,So we can see what we did, removed some\Nspaces and added some formatting
Dialogue: 0,0:04:23.65,0:04:24.86,Default,,0000,0000,0000,,at the bottom
Dialogue: 0,0:04:28.70,0:04:31.58,Default,,0000,0000,0000,,Now the next step is to click "Create Pull\NRequest"
Dialogue: 0,0:04:32.56,0:04:35.54,Default,,0000,0000,0000,,So as we are working in our own fork,\Nin our own copy
Dialogue: 0,0:04:35.54,0:04:40.58,Default,,0000,0000,0000,,the pull request is basically where you\Nask maintainers of the official version
Dialogue: 0,0:04:40.58,0:04:46.40,Default,,0000,0000,0000,,like "this is the change I made, can you\Nplease include it in the official version"
Dialogue: 0,0:04:47.27,0:04:52.77,Default,,0000,0000,0000,,So we can just click that button which\Nwill give us a new form to fill out
Dialogue: 0,0:04:54.40,0:04:58.46,Default,,0000,0000,0000,,basically the information needed by the\Nmaintainers to see if it's a good change
Dialogue: 0,0:04:58.46,0:04:59.25,Default,,0000,0000,0000,,or not
Dialogue: 0,0:05:00.14,0:05:03.32,Default,,0000,0000,0000,,So we can describe this as
Dialogue: 0,0:05:05.26,0:05:12.92,Default,,0000,0000,0000,,"Some formatting issues on addHeaderFIles\NPage causing table to not render properly"
Dialogue: 0,0:05:17.60,0:05:20.56,Default,,0000,0000,0000,,which affects version 2.x
Dialogue: 0,0:05:20.90,0:05:24.99,Default,,0000,0000,0000,,cause we do have different versions in\Nthe documentation now
Dialogue: 0,0:05:26.37,0:05:29.82,Default,,0000,0000,0000,,and we don't have a relevant issue \Nfor this one
Dialogue: 0,0:05:32.02,0:05:34.04,Default,,0000,0000,0000,,So this is basically what we need\Nto fill out
Dialogue: 0,0:05:35.66,0:05:41.19,Default,,0000,0000,0000,,At this point the maintainers of the \Nproject get a notification
Dialogue: 0,0:05:41.19,0:05:43.87,Default,,0000,0000,0000,,that there's a new change
Dialogue: 0,0:05:44.38,0:05:47.19,Default,,0000,0000,0000,,I can actually show you what that\Nlooks like
Dialogue: 0,0:05:47.70,0:05:50.55,Default,,0000,0000,0000,,when I'm bringing my other screen
Dialogue: 0,0:05:53.18,0:05:57.48,Default,,0000,0000,0000,,So this is the same repository except now \NI'm logged in as my main user account
Dialogue: 0,0:05:58.18,0:06:01.67,Default,,0000,0000,0000,,and I can see that Mark-H2, who is a\Nfirst-time contributor
Dialogue: 0,0:06:01.67,0:06:04.83,Default,,0000,0000,0000,,has suggested some changes
Dialogue: 0,0:06:05.36,0:06:07.52,Default,,0000,0000,0000,,I can review them through the files tab
Dialogue: 0,0:06:08.85,0:06:12.74,Default,,0000,0000,0000,,and when I say "okay this is a good\Nchange, something we really need"
Dialogue: 0,0:06:12.74,0:06:16.02,Default,,0000,0000,0000,,I can merge it from here.
Dialogue: 0,0:06:17.69,0:06:22.77,Default,,0000,0000,0000,,So I'll confirm that and at this point the\Nchange is made in the official version
Dialogue: 0,0:06:23.40,0:06:27.61,Default,,0000,0000,0000,,What happens next is that the change needs\Nto be deployed which is semi-automatic
Dialogue: 0,0:06:27.61,0:06:29.73,Default,,0000,0000,0000,,it will be fully automatic soon
Dialogue: 0,0:06:30.55,0:06:33.73,Default,,0000,0000,0000,,So it looks like it's completed (the deployment)
Dialogue: 0,0:06:35.90,0:06:39.11,Default,,0000,0000,0000,,so now I can go back to my\Ndocumentation
Dialogue: 0,0:06:39.90,0:06:42.12,Default,,0000,0000,0000,,and if I refresh the page
Dialogue: 0,0:06:43.55,0:06:47.90,Default,,0000,0000,0000,,you will see that it is now a little\Nbit better
Dialogue: 0,0:06:48.17,0:06:51.04,Default,,0000,0000,0000,,there are still some formatting issues\Nhere where it's breaking up the line
Dialogue: 0,0:06:51.04,0:06:54.35,Default,,0000,0000,0000,,but that's a design thing that needs to\Nbe addressed differently
Dialogue: 0,0:06:55.23,0:06:59.33,Default,,0000,0000,0000,,you can see that the other change we made\Nhere, properly marking these as code
Dialogue: 0,0:06:59.81,0:07:01.80,Default,,0000,0000,0000,,did apply properly
Dialogue: 0,0:07:05.12,0:07:08.75,Default,,0000,0000,0000,,So that's basically the process for\Nediting the documentation.
Dialogue: 0,0:07:09.69,0:07:14.53,Default,,0000,0000,0000,,You can go to anywhere on this website\Nto find the edit page link
Dialogue: 0,0:07:14.57,0:07:17.17,Default,,0000,0000,0000,,to get directly to the right page\Non GitHub
Dialogue: 0,0:07:18.14,0:07:21.72,Default,,0000,0000,0000,,If you go to Github you can also browse\Nthe documentation from there
Dialogue: 0,0:07:22.23,0:07:25.71,Default,,0000,0000,0000,,You can see we currently have English,\NDutch and Russian versions
Dialogue: 0,0:07:26.65,0:07:28.94,Default,,0000,0000,0000,,English is the source version
Dialogue: 0,0:07:28.94,0:07:32.45,Default,,0000,0000,0000,,the others are translations, and\Nespecially Russian is coming along nicely
Dialogue: 0,0:07:34.36,0:07:39.07,Default,,0000,0000,0000,,We can just browse around here and say\Nokay maybe I want to change something
Dialogue: 0,0:07:39.07,0:07:42.49,Default,,0000,0000,0000,,in... I don't know.. the api reference
Dialogue: 0,0:07:43.26,0:07:45.10,Default,,0000,0000,0000,,which is not a very interesting page
Dialogue: 0,0:07:46.33,0:07:49.23,Default,,0000,0000,0000,,but then there's the edit link right here\Nat the top
Dialogue: 0,0:07:49.90,0:07:52.87,Default,,0000,0000,0000,,that will again bring us to the same\Npage we saw before
Dialogue: 0,0:07:52.87,0:07:56.67,Default,,0000,0000,0000,,where we can edit the page, edit the\Nsource of the page, and propose
Dialogue: 0,0:07:56.67,0:07:59.64,Default,,0000,0000,0000,,the change at the bottom which will\Nsend us into the pull request
Dialogue: 0,0:07:59.64,0:08:02.87,Default,,0000,0000,0000,,for the process of getting it merged\Ninto the official version
Dialogue: 0,0:08:04.14,0:08:08.31,Default,,0000,0000,0000,,I do want to encourage everybody to\Njust see if you can help out with this
Dialogue: 0,0:08:08.90,0:08:12.96,Default,,0000,0000,0000,,there are a couple of issues logged\Non github as well
Dialogue: 0,0:08:12.96,0:08:15.96,Default,,0000,0000,0000,,with things that have been identified\Nas needing to be fixed
Dialogue: 0,0:08:16.75,0:08:18.25,Default,,0000,0000,0000,,Thanks for watching
Dialogue: 0,0:08:18.25,0:08:22.66,Default,,0000,0000,0000,,I hope this shows how you can help out,\Nhow you can contribute to the new docs
Dialogue: 0,0:08:22.66,0:08:26.24,Default,,0000,0000,0000,,without needing to know all about how\Ngit works
Dialogue: 0,0:08:26.24,0:08:30.76,Default,,0000,0000,0000,,just the basics of changing a file and \Nsubmitting it to be included