GitLab Static Site Editor, 28 Sep 2020

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: Static Site Editor – Call for Feedback

Description

Calling all Product Managers and anyone who edits the Product pages of the GitLab Handbook: We need your feedback!

Here's how to use the Static Site Editor ☝️

Feedback can be left here 👉 https://gitlab.com/gitlab-org/gitlab/-/issues/229952

Enjoy!

A

Hi everyone, my name- is eric schroeder and for those that don't know me very well, I'm the product manager for the static site, editor group here at gitlab and I'm recording this because as a product manager or somebody who edits the product pages frequently enough, I need your help. I need to get some feedback because we're about to introduce the static site editor as an editing option for the entire handbook and to get there. We've actually made it available already on the product pages.

A

So I'm going to show you a little bit about where we are with the feature how you can use it today to edit pages and what is coming up next and and what to look out for so this is a product page. It is in production. This is a live page and um you can see it's a fairly lengthy one with tables and graphs and charts and stuff like that uh down in the bottom of the footer, where you would normally find the edit links. We now have a static site, editor link.

A

All you have to do to edit this in the static site. Editor is click. The link and it'll open up now some highlights of the feature. If you haven't used this, yet we have a wysiwyg or what you see is what you get editing mode. So all your typical formatting shortcuts are there. We can bold and italicize text. We can change the.

A

Heading level, if you wanted that to be h3 or something like that, we also have visual table editing, which is great, because editing tables in markdown can be rather tedious. But here you can edit directly in the.

A

In the cell, you can even right click and add a row column, remove a row or column and align the text within the table. So that's really great saves a lot of time and if you do need to dive into the actual markdown, we also have a mode here where you can toggle over and see the raw source and you'll be able to see all the changes you make live. You can see that we added the correct syntax for strong and emphasis here.

A

We, the edits we made to the table, are live and then, if I go in here and make changes to the markdown and switch back over to the wysiwyg editor you'll see the changes are reflected there.

A

There's uh one other thing that is really nice. You can see it in action here in in the wysiwyg editor. We have spell check which is kind of nice um when you're done all you do, is click submit changes and it's going to generate a merge request.

A

And that merge request is going to be on a separate branch. That's created just for these batch of changes.

A

I will note that when we send this merge request, it's got uh it's pretty bare bone, so we would probably, within this organization, appreciate if you went and edited the title and description to be a little more uh relevant for those that are going to be reviewing the mr and we're working on making that available within the static site editor in later iterations. So when I view that merge request, you can see the changes that were made and you can go and edit your merge request description so that people know what they're looking at.

A

Now, where I need your help, I'm going to include this issue in the description for the video, but also when I post to this in slack I'll, send a link, but we have an issue open about um some feedback. So I I list some known issues and known limitations with the editor here, but I'd really appreciate it. If you had any feedback at all good, bad or indifferent.

A

Please add a comment here, we'll make sure that it aligns with anything that's already in our backlog or if it's new, we will create an issue for you, some of the things that are coming soon, just to know about we're working in actually in 13.3 to wrap up work on the ability to upload images directly into the static site editor as well as embed youtube, videos or other media and other video embeds.

A

We're also, as I mentioned working on the uh the actual mr creation flow, to provide more description and context with that merge request that we create and then we'll be working shortly on the ability to edit the the front matter on the markdown file. So things like the page title or any of the associated metadata.

A

So I really appreciate your help in advance. I hope you enjoy using this static site. Editor. Send me messages on slack. You can reach us at the static site, editor group, slack channel or even better leave us feedback in this issue. Thank you very much.