joomla/docs.joomla.org

Joomla! Documentation website store

PROOF OF CONCEPT

This Repository is a proof of concept for replacing or extending the current mediawiki solution with docusaurus.

Joomla! Documentation

This repository should hold all Joomla! documentation needed to use Joomla!.

The Documentation can be found at https://docs-next.joomla.org

Development

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ npm install

Local Development

$ npm run start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Preview for pull request

As part of the documentation validation we create a subdomain for previewing your pull request. The Link will be added to the "checks" section in the pull request as "preview". The url used is http://pr-[prnumber].docs.joomlacode.org

How to use

Unfinished sections

Please use the following placeholder for unfinished sections of a document.

:::note TODO

This section is missing, please use the **Edit this Page** link at the bottom of this page to add this section.

:::

If the page is not completed yet and bigger parts are missing use

:::caution TODO

This page is unfinished, please use the **Edit this Page** link at the bottom of this page to help make it more useful.

:::

docs.joomla.org's Issues

JDocs Mainpage

Technical Recirements outdatet and missing reqirements for Joomla! 5
redirect link to https://manual.joomla.org/docs/next/get-started/technical-requirements/
and all will be fine :-)

TopMenu hardcoded not CDN

The Topmenu seems to be hardcoded and not via the CDN.
Therefore is very outdated, which will create confusion for our users.

Anomaly in Chunk4x Title render

Compare these three URLs:

https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_Action_Log_Group
https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_Action_Log_Group/en
https://docs.joomla.org/Chunk4x:Extensions_Plugin_Manager_Edit_Action_Log_Group/de

The article titles all have the Chunk4x namespace and look like this:

Extensions Plugin Manager Edit Action Log Group
Chunk4x:Extensions Plugin Manager Edit Action Log Group
Erweiterungen Plugin Manager Aktionsprotokollgruppe bearbeiten

So the automated /en translation is having Chunk4x carried through into the title. That is a problem because in some places the Chunks are used as stand-alone documents.

Add scrolling-padding-top: 100px; to docs template

@conconnl as per the PR's from last October:
joomla/joomla-websites#1546
https://github.com/joomla/jdotorgtemplate/issues/181

It looks like the addition of scroll-padding-top that was added to the main templates has not made it across to the jdocs template.

  html { 
    scroll-padding-top: 100px; /* height of sticky header on Joomla template */ 
  }

Can you added it to resolve the issue raised today in JDocs Working Group on Glip with the jumping to an anchor on the page tucking underneath the sticky header.

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Awaiting Schedule

These updates are awaiting their schedule. Click on a checkbox to get an update now.

• Lock file maintenance

Detected dependencies

npm

package.json

• @cmfcmf/docusaurus-search-local ^1.1.0
• @crowdin/cli ^3.10.0
• @docusaurus/core 2.4.3
• @docusaurus/preset-classic 2.4.3
• @mdx-js/react ^1.6.22
• clsx ^1.2.0
• prism-react-renderer ^1.3.5
• react ^17.0.2
• react-dom ^17.0.2
• react-icons ^4.4.0
• @docusaurus/module-type-aliases 2.4.3
• node >=16.14

Navbar is Not working Properly

CURRENT BEHAVIOUR: When you go to https://docs.joomla.org from any Mobile device. The Navbar Keeps floating when you scroll down.