PR#19: New page: Design & UX entrypoint (part of #8) - fedora-docs/documentation-contributors-guide

fedora-docs / documentation-contributors-guide

#19 New page: Design & UX entrypoint (part of #8)

Merged 3 years ago by mattdm. Opened 3 years ago by jflory7.

add/designer-docs into master

New page: Design & UX entrypoint (part of #8)

Justin W. Flory • 3 years ago

c1b7482

modules/contributing/nav.adoc

file modified

+9 -6

		`@@ -1,9 +1,12 @@`
		`* xref:index.adoc[Contributing]`
		`- ** xref:prerequisites.adoc[Prerequisites]`
		`+ ** For writers:`
		`+ *** xref:prerequisites.adoc[Prerequisites]`
		`//** xref:repo-structure.adoc[Repository Structure]`
		`- ** xref:contributing-to-existing-docs.adoc[Contributing to Existing Documentation]`
		`- ** xref:adding-new-docs.adoc[Adding New Documentation to the Site]`
		`- ** xref:local-preview.adoc[Building a Local Preview]`
		`- //** xref:working-with-translations.adoc[Working with Translations]`
		`+ *** xref:contributing-to-existing-docs.adoc[Contributing to Existing Documentation]`
		`+ *** xref:adding-new-docs.adoc[Adding New Documentation to the Site]`
		`+ *** xref:local-preview.adoc[Building a Local Preview]`
		`//** xref:markup.adoc[ASCIIDoc Markup]`
		`- ** xref:git.adoc[Git for docs writers]`
		`+ *** xref:git.adoc[Git for docs writers]`
		`+ //** xref:working-with-translations.adoc[Working with Translations]`
		`+ ** For designers:`
		`+ *** xref:design-ux.adoc[Design & UX]`

modules/contributing/pages/design-ux.adoc

file added

+10

		`@@ -0,0 +1,10 @@`
		`+ = Design & UX of docs.fedoraproject.org site`
		`+ Fedora Documentation Team <docs@lists.fedoraproject.org>`
		`+`
		`+ This page explains how to contribute to the Fedora Docs Team as a designer or user interface (U.I.) / user experience (U.X.) developer.`
		`+`
		`+ https://pagure.io/fedora-docs/fedora-docs-ui[fedora-docs-ui]::`
		+ Sources of a U.I. for the new `docs.fedoraproject.org` site.
		`+`
		`+ https://docs.antora.org/antora-ui-default/build-preview-ui/[Build a UI Project for Local Preview]::`
		+ Official `antora.org` documentation on how to build a preview site using a custom U.I.

jflory7 commented 3 years ago

This commit creates a new page for designers who may want to contribute
to the Fedora Documentation site theming and style. As @ferdnyc subtly
demonstrated for us in fedora-docs/docs-fp-o#148, we do not do a great
job of telling people where to take their bugs or new ideas for the
Fedora Docs site user interface.

This page is not great either but it is a start! My immediate use case
is this gives me a link I can point people to who might be interested in
helping with design tasks and issues.

We can iterate and improve on this as we go. Part of #8.

Metadata Update from @jflory7:
- Pull-request tagged with: type - new docs
- Request assigned

3 years ago

ferdnyc commented 3 years ago

I am a misfiling bug reporter, and I approve this message.

mattdm commented 3 years ago

This seems pretty lightweight of a change, an obvious improvement, and appears correct. So I'm gonna just go ahead and mash the "merge" button on this one. :)