Skip to content
GitLab
Projects Groups Topics Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Register
  • Sign in
  • D DeveloperPortal
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributor statistics
    • Graph
    • Compare revisions
  • Issues 13
    • Issues 13
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 1
    • Merge requests 1
  • Deployments
    • Deployments
    • Releases
  • Packages and registries
    • Packages and registries
    • Container Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Commits
  • Issue Boards
Collapse sidebar
  • Community
  • DeveloperPortal
  • Issues
  • #23
Closed
Open
Issue created Sep 21, 2018 by Bastian Ilsø Hougaard@bastianilsoDeveloper

Developer Center Content Plan

This issue tracks the short-term and long-term content plan for the GNOME Developer Center. The content plan is initially based on the Developer Center Whiteboard Design by @aday.

Note: Primarily this consists of notes by me for now, will need review.

Base Structure

The base structure consists of elements which are be accessible from the front page.

frontpagethumb

  • "Get Started" (Key Item)
  • API Reference (Core Item)
  • Design Guidelines (Core Item)
  • Tutorials (Core Item)
  • Distribute (Core Item)
  • Technologies Overview (Secondary)
  • Get Involved in GNOME (Secondary)
  • GNOME Development Guides (Secondary)

Get Started

The guide explains how to get started developing apps in GNOME.

Short-term plan:

  • This guide will need writing. Maybe Getting Started with GTK+ would be a good inspiration?

Long-term plan:

  • Perhaps, to have a dedicated maintainer of this guide?

API Reference

api-references.thumb Shows a view of essential libraries and platforms, divided into topics.

Short-term plan:

  • Generate documentation where possible. Fx with Hotdoc, libraries ported to HotDoc would shows nicely integrated documentation.
  • Hardlink to gtk-doc documentation in places where libraries are not ported.
  • External link to external projects' API reference where relevant.

Long-term plan:

  • All generated documentation integrates with the documentation system.
  • External links. I guess we still have to link to the external references. But maybe we can integrate them in our Search system and get notifications if the links die.

Design Guidelines

Short-term plan:

  • Port over the HIG from Mallard.

Long-term plan:

  • Maintain the HIG in markdown format.

Tutorials

tutorials-thumb Tutorials only focused on application development.

Short-term plan:

  • Review and select HOWDOI tutorials to port over which are still relevant from the wiki.

Long-term plan:

  • Create Redirects to the new tutorials.
  • Have sections with various topics fx:
  • Playground: Tutorials for beginners.
  • Multimedia: ..
  • Online Integration: ..

Distribute

This is essentially information Flatpak developer documentation and other information which falls into Distribution category (GNOME Release Schemes, Versioning, AppData?)

Short-term plan:

  • External link to the Flatpak developer documentation

Long-term plan:

  • Migrate Flatpak developer documentation to GNOME Developer Center? Although Flatpak is not a GNOME project.
  • Maybe we can somehow integrate it anyway even if it is external? Through Search, cross-reference etc.

Technologies Overview

This is an overview of the technologies GNOME encompasses and builds upon.

Short-term plan:

  • Link to https://www.gnome.org/technologies/

Long-term plan:

  • Move https://www.gnome.org/technologies/ into the Developer Center? Or continue linking https://www.gnome.org/technologies/

Get Involved

Short-term plan:

  • Links to the Newcomer Coding Guide https://wiki.gnome.org/Newcomers/

Long-term plan:

  • Migrate the newcomer guide to the Developer Center.

GNOME Development Guides

This seems to overlap with the purpose of "Tutorials" to me. Maybe we can have "Contribute to Developer Docs / Migrate to Developer Docs?" here instead or something else?

Edited Oct 14, 2018 by Bastian Ilsø Hougaard
To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information
Assignee
Assign to
Time tracking