joomla / api.joomla.org Goto Github PK
View Code? Open in Web Editor NEWRepository containing the source files for building the Joomla! API website
Home Page: https://api.joomla.org
License: GNU General Public License v2.0
api.joomla.org's People
Contributors
Stargazers
Watchers
Forkers
puneet0191 leonardoleo harshitaaaaaa hackwar joomla-dependency-bot isabella232 amykrizanwangapi.joomla.org's Issues
Missing J4.4 / J5 API documentation
api.joomla.org seems to be stuck at Joomla 4.3 while in the meantime, 2 releases in both the Joomla 4.4 and Joomla 5.0 branch have been released.
Website is down
I noticed that since 01 Oct 2023 the site api.joomla.org is down.
I've checked with a 3rd party website https://isitdownorjust.me and it shows down as well.
Broken links to classes
Links to classes from other classes are broken. To reproduce, click either AbstractEvent link here https://api.joomla.org/cms-4/classes/Joomla-CMS-Event-GenericEvent.html.
FooterMenu is hardcode not CDN
The FooterMenu seems to be hardcoded, while the CDN is updated regularly when changes happen.
https://github.com/joomla/api.joomla.org/blob/master/index.html#L244-L289
TopMenu is hardcode not CDN
The TopMenu seems to be hardcoded, while the CDN is updated regularly when changes happen.
https://github.com/joomla/api.joomla.org/blob/master/index.html#L62-L157
Update iviewer?
phpDocumentor comes with an outdated version of iviewer for the class hierarchy diagram. That script has been abandoned for several years already, but maybe we should still consider updating this for our website separately. https://github.com/natashawylie/iviewer/tags
Support linking `@link` tags
Misoriented buttons
Subject of the issue
The Download and Launch buttons are disoriented for screen sizes between 304px - 462px.
The Download button is at the center of the screen while the Launch button is slightly shifted to right.
Steps to reproduce
Check for screen sizes between 462px and 304px.
Expected behaviour
Both the buttons should be at the perfect center of the screen.
Actual behaviour
The misorientation can be seen in the following image:
Reorg Repo
- Put web assets into a
wwwdirectory - Put phpDocumentor template into its own directory
Fix @see tag linking
Needs updating
Since @bembelimen changed the deprecation dates etc with joomla/joomla-cms#38657 the API docs need to be regenerated.
I don't have the necessary permissions or I would have done it myself
Evaluate our template for new features in phpDocumentor 3
Our template for phpdocumentor is rather old. We should consider going through all the features phpDocumentor has by default and amending our template in that regard where usefull.
Navbar overlaps the header
Subject of the issue
The Header gets partially overlapped by the Navbar for screen sizes between 962px and 1182px.
Steps to reproduce
Use developer options to check for the sizes from about 1182px to 962px.
Expected behaviour
The Navbar should not overlap the Header and the Header should be completely visible.
Actual behaviour
For screen sizes from 962px to 1182px the following result is produced:
Pingdom still in the code
Pingdom is still in the code, but we don't use it.
https://github.com/joomla/api.joomla.org/blob/master/index.html#L45-L55
Hamburger(Collapsed) menu doesn't closes on click
Subject of the issue
The Hamburger menu, once opened by a click, can not be closed by another click.
There is no way to close the menu without refreshing the page.
Steps to reproduce
Click the Hamburger menu to open it.
Now click it again to close it, NOT WORKING.
Expected behaviour
Clicking the open Hamburger menu should close(collapse) it.
Actual behaviour
Clicking the open Hamburger menu isn't closing it.
Missing page (404)
Hey guys,
the following page is missing: https://api.joomla.org/cms-3/classes/JAuthenticationResponse.html
Now I'm asking how I can make it, that the function onUserAuthorisation() denies a users login. What does this method need to return?
Cleanup files in the repo
Right now the files of the static assets and the phpDocumentor are mixed together in the root folder of this repo. This should be split up into a static-assets folder and a template folder, leaving the rest of files in the root of the repo.
Invalid links to class methods due to base href="../" in header
The <head> contains an entry <base href="../"> (rendered apparently by renderBaseUrlHeader in layout.html.twig.
The links to specific methods in the class overview on the left for a specific class contain only the hash and name and not a link specifically to the current page (I think this is in class.sidebar.html.twig.
Therefore, these links lead to a wrong URL.
For example:
- Go to https://api.joomla.org/cms-4/classes/Joomla-CMS-Access-Access.html
- Click on the "check" link on the left
- Browser navigates to "https://api.joomla.org/cms-4/#method_check" when it actually should go to "https://api.joomla.org/cms-4/classes/Joomla-CMS-Access-Access.html#method_check".
Possible fixes:
- Remove the
<base href="../">entry. But it's probably there for some reason and removing it would break other things? - Add a fixed link to the current page in front of the
#.
Dependency Dashboard
This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.
Open
These updates have all been created already. Click a checkbox below to force a retry/rebase of any.
Detected dependencies
composer
composer.json
consolidation/robo ~3.0.4
Content covered by nav menu when using within-page links (#)
When using the link to navigate to a method (currently only possible by directly entering the respective URL, see #43), the method name and first line of content are covered by the nav bar.
For example, navigate to https://api.joomla.org/cms-4/classes/Joomla-CMS-Access-Access.html#method_check
The two first lines containing
check
Method to check if a user is authorised to perform an action, optionally on an asset.
are covered by the nav bar, which can be quite confusing.
It looks like this:
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.