Skip to content
This repository was archived by the owner on Nov 10, 2019. It is now read-only.

Commit 4448b70

Browse files
antweissamir-codefresh
authored andcommitted
Fix documentation links (#48)
1 parent 9ba6886 commit 4448b70

File tree

3 files changed

+7
-6
lines changed

3 files changed

+7
-6
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,9 @@ This repository is used by Plugin developers for maintaining the official plugin
99

1010
### How to Contribute a Plugin
1111

12-
1. Fork this repository, develop and test your Plugin
13-
2. Choose the correct folder for your plugin based on the information in the [Repository Structure](README.md#repository-structure) section
12+
1. Develop and test your plugin
13+
2. Fork this repository
14+
2. Choose the correct folder for your plugin based on the information in the [Repository Structure](docs/plugin.md#plugin-file-structure) section
1415
3. Ensure your Plugin follows the [technical](#technical-requirements) and [documentation](#documentation-requirements) guidelines, described below
1516
4. Update [Plugin Catalog](CATALOG.md)
1617
5. Submit a pull request

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Codefresh plugins
22

3-
Codefresh Plugins are Docker images made especially for use in a Codefresh freestyle step. Each plugin facilitates a common task that would otherwise by difficult to achieve.
3+
Codefresh Plugins are Docker images made especially for use in Codefresh freestyle steps. Each plugin facilitates a common task that would otherwise be difficult to achieve.
44
See each plugin readme for more info and usage instructions.
55

66
## Plugins

docs/plugin.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ then they can be packaged into versioned archives to be deployed.
66
This document explains the plugin format, and provides basic guidance for
77
building plugins.
88

9-
## The Plugin File Structure
9+
## Plugin File Structure
1010

1111
A plugin is organized as a collection of files inside of a directory. The
1212
directory name is the name of the plugin (without versioning information). Thus,
@@ -17,7 +17,7 @@ Inside of this directory, Codefresh will expect a structure that matches this:
1717
```
1818
kube-deploy/
1919
plugin.yaml # A YAML file containing information about the plugin
20-
LICENSE # OPTIONAL: A plain text file containing the license for the chart
20+
LICENSE # OPTIONAL: A plain text file containing the license for the plugin
2121
README.md # OPTIONAL: A human-readable README file
2222
NOTES.md # OPTIONAL: A plain text file containing short usage notes
2323
```
@@ -95,4 +95,4 @@ cannot be overridden.
9595
### Predefined Volumes and Files
9696

9797
- `/codefresh/volume` - same volume mounted to all steps running in Codefresh pipeline
98-
- `/codefresh/volume/env_vars_to_export` - a placeholder file to filled with **exported** environment variables; any exported variable can be used in subsequent pipeline steps
98+
- `/codefresh/volume/env_vars_to_export` - a placeholder file to be filled with **exported** environment variables; any exported variable can be used in subsequent pipeline steps

0 commit comments

Comments
 (0)