gitlab-org / coming-soon

Content Management

This outline covers the content management system (CMS) for the Coming Soon page project. It aims to provide developers with a clear understanding of the system’s structure, features, and usage.

Content Structure

Content is organized in a hierarchical structure using a combination of files and folders.

  • Root Folder: The base directory for all content. This folder typically contains subfolders for different sections or categories of content.
  • Content Files: Each individual piece of content is stored in a dedicated file. The file format can vary based on the content type.
  • Metadata Files: Each content file may have associated metadata files (e.g., YAML or JSON) to define properties and attributes of the content. This metadata helps control how the content is displayed or processed.

Example:

├── content
          │   ├── blog
          │   │   ├── posts
          │   │   │   └── 2023-03-15-first-post.md
          │   │   └── categories
          │   │       └── technology.yaml
          │   ├── about
          │   │   └── team.md
          │   └── services
          │       └── web-development.md

Source: This content structure is based on the project’s current setup. Further information can be found in the coming soon repository.

Content Types

The project supports various content types, each having specific features and functionality:

  • Text: Plain text content, often used for pages, articles, or simple descriptions.
  • Images: Image files, used for visual elements like logos, banners, or product images.
  • Code: Code snippets, used for highlighting code examples or integrating dynamic content.
  • Dynamic Elements: Elements like forms, interactive maps, or user-generated content, allowing for greater flexibility in content presentation.

Example:

  • Text: A blog post or an “About Us” page would primarily use text content.
  • Images: A company logo or a product image would be represented by image files.
  • Code: Code snippets demonstrating a specific API call or script could be displayed within the content.
  • Dynamic Elements: A contact form or a map displaying store locations would be examples of dynamic elements.

Source: This information is drawn from discussions and code examples within the project. Please refer to the coming soon repository for further details.

Content Management Features

  • Editing: The content management system allows for easy editing of content.
  • Versioning: Content changes are tracked, providing a history of modifications.
  • Publishing: Content can be easily published or unpublished as needed.
  • Accessibility: The system ensures that all content is accessible and meets accessibility standards.
  • Security: Measures are in place to protect content from unauthorized access.

Source: These features are based on the project’s current implementation and can be reviewed in the coming soon repository.

Developer Guidelines

  • Content Conventions: Adhere to the established content naming conventions and file organization.
  • Metadata Usage: Properly utilize metadata to enhance content management and control its presentation.
  • Accessibility Best Practices: Prioritize accessibility when creating and editing content.
  • Security Considerations: Follow security guidelines to protect content and user data.

Source: The project’s codebase and documentation provide specific guidelines for content management. Refer to the coming soon repository for detailed instructions.