GitLab Handbook Help, 21 May 2020

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: How to add a new directory and page to the handbook

Description

In this video, Sarah Daily, marketing operations manager at GitLab, shows Wil Spillane, social marketing manager at GitLab, how to add a new page to your section of the handbook complete with a new main page and table of contents.

A

Okay, so today we're gonna walk through how to add a new directory to your section of the handbook so that if one of these links on your table of contents on the right-hand side, we're not an anchor link on this page, it would actually lead to another page uh nested, underneath the social marketing page.

A

So what we're gonna do we're just gonna, scroll down and edit this page, like you, normally do to set up a merge request and then I'm actually going to go back to the social marketing directory from the breadcrumbs up here. So you can see. I can go to the corporate marketing folder so on and so forth up here. So this is where you want to add your folder: well, yes, okay!

A

So what I'm going to do to add that is I'm going to click the plus sign up here and I'm going to create a new directory from this directory, so I'm in a new directory.

A

Typically, the directories are just lowercase. It doesn't really matter because it's not shown on the front end. So what is the name of the folder or directory that you want so.

B

My intent of this page is to move all of the administrative guidelines for handbook updates issues. The way we work into it so I would likely use this as an admin page.

A

Okay, is it cool if I just call it admin, then yeah.

B

Absolutely okay.

A

And I'm just gonna call this new directory men and I'm just gonna use. My typical ranch name here create directory.

A

Okay and I'm gonna go ahead and make this whip, because we have a couple more steps that we need to do to make this work.

A

A

A

Now I'm gonna go back into that branch and I'm going to open it in a new tab and.

A

Unfortunately, I do now have to navigate back to.

A

That section of the handbook.

A

Is it under social media guidelines or you guys would be it.

B

Sport or marketing, okay, yeah social.

A

Marketing, okay, now we can see we have that new directory and I'm gonna go into it, but we don't have the index.html right. So that's what I'm going to add now I'm going to add that file, so you can actually add markdown to that. So again, from this folder I'm going to click, the plus sign and I'm going to do new file and then in the file name, you're gonna want to put index.html MD for markdown. You don't need to select a template type and then to have a new page.

A

Have the table of contents there's a little snippet and I'll send it to you after this, so that you can hang on to it and I'm just gonna copy that and paste it here. Obviously, I took this from my path, factory page. So what do you want? The title of the page to be.

B

Social media administration.

A

Okay and I'm gonna say add admin page and just to give it a little bit of content before I'm. Just gonna put something here and you can delete it in the next commit.

A

That's not a word y'all. You.

B

Know what we're going right, I haven't.

A

Finished my coffee, yet.

A

We're just gonna go with that: okay, commit changes.

A

Okay, mm-hmm and now I can see it's already set that up for me and the changes are committed. So I'll go back to my merge request and I can see it added that there, and that is how you add, a new directory and a new file with table of content ready on the handbook.