Skip to content

Commit

Permalink
copied docs from old site
Browse files Browse the repository at this point in the history
  • Loading branch information
visto9259 committed Feb 22, 2024
1 parent dd0358e commit 471dc98
Show file tree
Hide file tree
Showing 61 changed files with 2,132 additions and 0 deletions.
44 changes: 44 additions & 0 deletions .github/workflows/deploy-gh-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Build and Deploy to GitHub Pages

defaults:
run:
shell: bash
working-directory: ./docs

on:
push:
paths:
- 'docs/**'

jobs:
deploy:
name: Build and Deploy to GitHub Pages
runs-on: ubuntu-latest
defaults:
run:
shell: bash
working-directory: ./docs
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: 18
cache: yarn
cache-dependency-path: docs/yarn.lock
- name: Install dependencies
run: yarn install --frozen-lockfile
- name: Build website
run: yarn build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
# Build output to publish to the `gh-pages` branch:
publish_dir: ./docs/build
# The following lines assign commit authorship to the official
# GH-Actions bot for deploys to `gh-pages` branch:
# https://github.com/actions/checkout/issues/13#issuecomment-724415212
# The GH actions bot is used by default if you didn't specify the two fields.
# You can swap them out with your own user credentials.
user_name: github-actions[bot]
user_email: 41898282+github-actions[bot]@users.noreply.github.com
29 changes: 29 additions & 0 deletions .github/workflows/test-deploy-gh-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Build GitHub Pages on PRs No Deploy

defaults:
run:
shell: bash
working-directory: ./docs

on:
pull_request:
paths:
- 'docs/**'
# Review gh actions docs if you want to further define triggers, paths, etc
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on

jobs:
test-deploy:
name: Build GitHub Pages
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: 18
cache: yarn
cache-dependency-path: docs/yarn.lock
- name: Install dependencies
run: yarn install --frozen-lockfile
- name: Test build website
run: yarn build
23 changes: 23 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Dependencies
/node_modules

# Production
/build

# Generated files
.docusaurus
.cache-loader

# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*

# IDE
.idea
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Website

This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.

### Installation

```
$ yarn
```

### Local Development

```
$ yarn 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

```
$ yarn build
```

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

### Deployment

Using SSH:

```
$ USE_SSH=true yarn deploy
```

Not using SSH:

```
$ GIT_USER=<Your GitHub username> yarn deploy
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
3 changes: 3 additions & 0 deletions babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = {
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
};
10 changes: 10 additions & 0 deletions blog/2022-08-02-welcome.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
slug: welcome
title: Welcome
authors: [ericr]
tags: [laminas, PHP]
---
Welcome to the new documentation website for the LM-Commons organization.

This site is work in progress and the intent is obviously to keep it current with updates to the LM-Commons packages.

11 changes: 11 additions & 0 deletions blog/2022-10-24-lmcbootstrapmenu-v1.0.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
slug: lmcbootstrapmenu-release-v1.0.0
title: LmcBootstrapMenu v1.0.0. is available
authors: [ericr]
tags: [laminas, PHP, bootstrap]
---
LmcBootstrapMenu is a new LM-Commons package that provides a Bootstrap menu helper.

The repository is available on GitHub [LM-Commons/LmcBootstrapMenu](https://github.com/LM-Commons/LmcBootstrapMenu).

It is also available on Packagist via Composer. Please see installation instructions in the `README.md` file in the GitHub repository.
5 changes: 5 additions & 0 deletions blog/authors.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
ericr:
name: Eric Richer
title: LM-Commons Admin
url: https://github.com/visto9259
image_url: https://github.com/visto9259.png
6 changes: 6 additions & 0 deletions docs/LmcRbacMvc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
sidebar_position: 2
---
LmcRbacMvc is a role-based access control Laminas MVC module to provide additional features on top of Laminas\Permissions\Rbac

[Documentation](https://lm-commons.github.io/lmcrbacmvc)
41 changes: 41 additions & 0 deletions docs/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
sidebar_position: 1
---

# Introduction

LM-Commons is a GitHub organization dedicated to the collaborative
and community-driven long-term maintenance of packages & libraries based on the Laminas MVC and Components.

Many of the packages found in the LM-Commons repositories are former ZF-Commons packages
that were migrated to the Laminas Project framework.

## LmcUser
LmcUser is a generic user registration and authentication module for Laminas. Supports Laminas\Db and Doctrine2.

## LmcRbacMvc
LmcRbacMvc is a role-based access control Laminas MVC module to provide additional features on top of Laminas\Permissions\Rbac

## LmcRbac

LmcRbac is a role-based access control module to provide additional features on top of Laminas\Permissions\Rbac (formerly zfc-rbac)

## LmcCors
LmcCors is a simple Laminas MVC module that helps you to deal with Cross-Origin Resource Sharing (CORS).

## LmcUserDoctrineORM
LmcUserDoctrineORM is a Doctrine2 ORM storage adapter for LmcUser.

## LmcAdmin
LmcAdmin is an admin interface for Laminas MVC framework.

## LmcMail
LmcMail is Wrapper for Laminas Mail that uses View Model to compose the email body.

##### Notices and Disclaimers
This is not an official Laminas Project organization.

Issues and questions related to the Laminas MVC and components
should be addressed to the Laminas Project organisation.

Laminas is a trademark of the Laminas Project, a Series of LF Projects, LLC.
27 changes: 27 additions & 0 deletions docs/lmc-admin/01-introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Introduction
>
> This is work in progress to convert to Laminas
>
# LmcAdmin Module for Laminas Framework
Created by [Jurian Sluiman](http://juriansluiman.nl) and [Martin Shwalbe](https://github.com/Hounddog).

## Introduction
LmcAdmin is a minimal admin interface for generic administrative purposes. It is a common screen with navigation that hides behind authentication and authorization.

## Installation
LmcAdmin is enabled to be installed via composer. Load `lm-commons/lmc-admin` in your `composer.json` file. You can specify its version (currently only 1.0.0 is recommended) or use `dev-master` to load the latest version from master. Enable LmcAdmin in your `module.config.php` configuration file.

If you do not want to use composer, clone this project (either as a git submodule or not) into `./vendor/` directory.

## Usage
LmcAdmin allows you to create routes under a single parent "admin" route. You can also use it to enable navigation in your admin layout. Furthermore integration of [LmcRbacMvc](https://github.com/LM-Commons/LmcRbacMvc) is provided.

The complete configuration is flexible, so you can update the zfcadmin parent route, its children, the navigation and all default provided view scripts. Read more in the [documentation](docs/lmc-admin/01-introduction.md) about usage and customization of LmcAdmin.

## Development
LmcAdmin is currently under development. The authors feel LmcAdmin is stable enough for production versions and you can always fix your LmcAdmin version to a specific tag.

## Support

- File issues at https://github.com/LM-Commons/LmcAdmin/issues.
- Ask questions in the [LM-Commons gitter](https://gitter.im/LM-Commons/community) chat.
8 changes: 8 additions & 0 deletions docs/lmc-admin/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "LmcAdmin",
"position": 5,
"link": {
"type": "generated-index",
"description": "Admin interface for Laminas MVC framework."
}
}
24 changes: 24 additions & 0 deletions docs/lmc-cors/01-introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Introduction
LmcCors is a simple Laminas MVC module that helps you to deal with Cross-Origin Resource Sharing (CORS).

It allows to easily configure your Laminas MVC application so that it automatically builds HTTP responses that follow the CORS documentation.

## What is CORS ?

CORS is a mechanism that allows to perform cross-origin requests from your browser.

For instance, let's say that your website is hosted in the domain `http://example.com`.
By default, user agents won't be allowed to perform AJAX requests to another domain for security
reasons (for instance `http://funny-domain.com`).

With CORS, you can allow your server to reply to such requests.

You can find better documentation on how CORS works on the web:

* [Mozilla documentation about CORS](https://developer.mozilla.org/en-US/docs/HTTP/Access_control_CORS)
* [CORS server flowchart](http://www.html5rocks.com/static/images/cors_server_flowchart.png)

## Support

- File issues at https://github.com/LM-Commons/LmcCors/issues.
- Ask questions in the [LM-Commons gitter](https://gitter.im/Lm-Commons/community) chat.
12 changes: 12 additions & 0 deletions docs/lmc-cors/02-installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Installation
Install the module by typing (or add it to your `composer.json` file):

```sh
$ php composer.phar require lm-commons/lmc-cors
```

Then, enable it by adding "LmcCors" in your `application.config.php` or `modules.config.php` file.

By default, LmcCors is configured to deny every CORS requests. To change that, you need to copy
the [`config/lmc_cors.global.php.dist`](https://github.com/LM-Commons/LmcCors/blob/master/config/lmc_cors.global.php.dist) file to your `autoload` folder
(remove the `.dist` extension), and modify it to suit your needs.
Loading

0 comments on commit 471dc98

Please sign in to comment.