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.

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

2.x Package Documentation Support #46

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

Conversation

mbabker
Copy link
Contributor

@mbabker mbabker commented Feb 20, 2019

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 and others added 12 commits March 3, 2019 12:39
This is a partial merge that does not deal with updating Composer/NPM locks or media resources
…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
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?

composer.json Show resolved Hide resolved
composer.json Outdated Show resolved Hide resolved
* @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.

…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
…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
…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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants