Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

2.x Package Documentation Support #46

Draft
wants to merge 66 commits into
base: master
Choose a base branch
from
Draft

2.x Package Documentation Support #46

wants to merge 66 commits into from

Conversation

mbabker
Copy link
Contributor

@mbabker mbabker commented Feb 20, 2019 •
edited
Loading

Infrastructure and UI changes needed for supporting rendering package docs on this website.

  • Adds symfony/cache package to cache rendered markup
  • Uses joomla/github to render markup via GitHub API in appropriate context
  • Uses GitHub's syntax highlighting CSS for code examples
  • Adds UI for a page type with a primary section and a sidebar, flex/grid should be done in a way where the sidebar is rendered after the main body on mobile devices
  • Adds info to database to determine if a package exists on a major version
  • Docs section routing:
    • /docs/:version/:package/:filename is the general pattern, where:
      • :version is either a major version branch (1.x or 2.x) or the shortcut "latest" (which will redirect to 2.x for now)
      • :package is the package name
      • :filename is the path to the file within a repo's docs directory (when omitted it redirects to the overview page)

screen shot 2018-02-24 at 9 42 19 pm

Michael Babker added 30 commits November 18, 2017 07:35
Start scaffolding for documentation area
3dfa165
Add flag tracking explicitly if a package has a major version branch
aae7dbe
Routing for package docs
8d4ab80
Set internal format on routing, make sure cached class exists
8d9c68a
Merge branch 'master' into package-docs
a91afc3
Merge branch 'master' into package-docs
9ab6fe4
Add latest version alias, fix routing from docs index
372be0c
Redirect from page controller too
0253aeb
Pull filename from request
2f293ad
Add to model sort method
d908e1f
Add an error HTML view for the documentation section, use it when doc…
130c8b6 
…s don't exist for a branch on the redirect controller
Rendering on docs page controller
b94731e
Merge branch 'master' into package-docs
a687799
Create command to pull package docs
8c25624
Add infrastructure for a single documentation page
1c25f48
Cache support
732331a
Render markdown to HTML
bdc2c15
Code syntax highlighting
bcb65e4
Preload has no v1
0a4b831
Comment
b968a8f
Change .md links so site nav works
e141740
Add package sidebar
110171b
Default to a separate sub-dir
90c5f87
More link tweaking so site nav works
4e5ed4c
Clean rendered cache when fetching files
f89ef70
Cache clear command
8767005
Debug bar integration for HTTP package
87904e2
Different message if package doesn't have 1.x release
62e567f
This needs to be else
6bcd360
Add another breakpoint for the sidebar since some of the text gets a …
6877e83 
…little long
Michael Babker and others added 12 commits March 3, 2019 12:39
Run PHP-CS-Fixer
60a1624
Merge branch 'master' into package-documentation
bf4a50d 
This is a partial merge that does not deal with updating Composer/NPM locks or media resources
Vendor update (re-gen lock from master merge)
0f545e2
Fix PHP 7.3 warning
a71612c
NPM update (re-gen lock from master merge), regenerate assets
dac417f
Fix class name
6229c0f
Undefined var
d26fc43
Lost clear cache command in loader
faab916
@Hackwar
Merge branch 'master' of github.com:Joomla/framework.joomla.org into …
0765144 
…package-documentation

# Conflicts:
#	assets/scss/bootstrap/_code.scss
#	assets/scss/bootstrap/_reboot.scss
#	assets/scss/font-awesome/_icons.scss
#	assets/scss/pages/_homepage.scss
#	composer.json
#	composer.lock
#	package-lock.json
#	package.json
#	packages.yml
#	src/Command/Package/SyncCommand.php
#	src/Helper.php
#	src/Helper/GitHubHelper.php
#	src/Model/PackageModel.php
#	src/Service/ApplicationProvider.php
#	src/Service/DebugBarProvider.php
#	src/Service/HttpProvider.php
#	src/View/Contributor/ContributorHtmlView.php
#	templates/homepage.twig
#	templates/index.twig
#	templates/status.twig
#	www/media/css/template.css
#	www/media/fonts/vendor/@fortawesome/fontawesome-free/webfa-brands-400.eot
#	www/media/fonts/vendor/@fortawesome/fontawesome-free/webfa-brands-400.svg
#	www/media/fonts/vendor/@fortawesome/fontawesome-free/webfa-brands-400.ttf
#	www/media/fonts/vendor/@fortawesome/fontawesome-free/webfa-brands-400.woff
#	www/media/fonts/vendor/@fortawesome/fontawesome-free/webfa-brands-400.woff2
#	www/media/fonts/vendor/@fortawesome/fontawesome-free/webfa-regular-400.eot
#	www/media/fonts/vendor/@fortawesome/fontawesome-free/webfa-regular-400.svg
#	www/media/fonts/vendor/@fortawesome/fontawesome-free/webfa-regular-400.ttf
#	www/media/fonts/vendor/@fortawesome/fontawesome-free/webfa-regular-400.woff
#	www/media/fonts/vendor/@fortawesome/fontawesome-free/webfa-regular-400.woff2
#	www/media/fonts/vendor/@fortawesome/fontawesome-free/webfa-solid-900.eot
#	www/media/fonts/vendor/@fortawesome/fontawesome-free/webfa-solid-900.svg
#	www/media/fonts/vendor/@fortawesome/fontawesome-free/webfa-solid-900.ttf
#	www/media/fonts/vendor/@fortawesome/fontawesome-free/webfa-solid-900.woff
#	www/media/fonts/vendor/@fortawesome/fontawesome-free/webfa-solid-900.woff2
#	www/media/js/template.js
#	www/media/mix-manifest.json
#	www/media/sri-manifest.json
@Hackwar
Fixing previous merge
7365848
@Hackwar
Fixing codestyle
60f3c3e
@Hackwar
Cleanup
79c0a04
@Hackwar
Copy link
Member

Hackwar commented Aug 23, 2022

I've pushed the latest changes from master into this branch to bring it up to date. @nibra @HLeithner maybe you want to have a look at this and if we want to adopt this finally?

nibra
nibra reviewed Aug 23, 2022
View reviewed changes
composer.json Show resolved Hide resolved
nibra
nibra reviewed Aug 23, 2022
View reviewed changes
composer.json Outdated Show resolved Hide resolved
nibra
nibra reviewed Aug 23, 2022
View reviewed changes
src/Command/GenerateSriCommand.php Outdated
* @var string|null
*/
protected static $defaultName = 'template:generate-sri';
/**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are several places with missing indentation for starting docblock comments

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was done automatically by phpcbf. Will have to look at this later.

@Hackwar Hackwar mentioned this pull request Aug 26, 2022
Closed
@Hackwar
Merge branch 'master' of github.com:Joomla/framework.joomla.org into …
13921cd 
…package-documentation

# Conflicts:
#	composer.lock
#	www/media/css/template.css
#	www/media/css/template.css.map
#	www/media/js/template.js
#	www/media/js/template.js.map
#	www/media/mix-manifest.json
#	www/media/sri-manifest.json
@Hackwar
Copy link
Member

Hackwar commented Aug 26, 2022

The question is: Who is going to finish this PR and who is going to write all that documentation?

@Hackwar Hackwar force-pushed the master branch 2 times, most recently from 9912ebf to d418ff4 Compare January 30, 2023 22:25
@Hackwar
Merge branch 'master' of github.com:Joomla/framework.joomla.org into …
8a9e8c0 
…package-documentation

# Conflicts:
#	composer.json
#	composer.lock
#	package-lock.json
#	src/Model/PackageModel.php
#	src/Service/ApplicationProvider.php
#	www/index.php
#	www/media/css/template.css
#	www/media/css/template.css.map
#	www/media/mix-manifest.json
#	www/media/sri-manifest.json
@Hackwar
Merge branch 'master' of github.com:Joomla/framework.joomla.org into …
7ea048e 
…package-documentation

# Conflicts:
#	composer.json
#	composer.lock
#	package-lock.json
#	src/Model/PackageModel.php
#	src/Service/ApplicationProvider.php
#	www/index.php
#	www/media/css/template.css
#	www/media/css/template.css.map
#	www/media/mix-manifest.json
#	www/media/sri-manifest.json
@Hackwar
Updating assets
7f9c414
@Hackwar
Updating dependencies, adding 3.x versions/branches
8c9f138
@Hackwar
Adding current version per branch to status page
873aa98
@Hackwar
Codestyle
babbdd5
@Hackwar
Some cleanup
817cafa
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nibra nibra nibra left review comments

@Hackwar Hackwar Hackwar left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@mbabker @Hackwar @nibra