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

docs: Addition of plugin docs #3066

Merged
merged 15 commits into from
Nov 18, 2022
Merged

docs: Addition of plugin docs #3066

merged 15 commits into from
Nov 18, 2022

Conversation

joshLong145
Copy link
Contributor

@joshLong145 joshLong145 commented Nov 4, 2022

Closes #3069

Addition of documentation for plugins under Knowledge Base Includes docs for plugin defined hooks which is tracked in: #3038

@aljo242 aljo242 added skip-changelog Don't check changelog for new entries component:docs Documentation additions or improvements. labels Nov 6, 2022
@ilgooz
Copy link
Member

ilgooz commented Nov 7, 2022

Great addition, thank you Josh!

@joshLong145
Copy link
Contributor Author

joshLong145 commented Nov 7, 2022

Updated docs per @tbruyelle comments. Changes structure to have two primary categories

  • Using Plugins
  • Developing Plugins

@joshLong145
Copy link
Contributor Author

joshLong145 commented Nov 7, 2022

Seeing that the deployment action is throwing an error relating to firebase credentials:

/home/ubuntu/actions/runner-0/_work/_actions/FirebaseExtended/action-hosting-deploy/v0/bin/action.min.js:274
[10](https://github.com/ignite/cli/actions/runs/3413507429/jobs/5680294482#step:7:11)
        throw new Error(`Input required and not supplied: ${name}`);
[11](https://github.com/ignite/cli/actions/runs/3413507429/jobs/5680294482#step:7:12)
        ^

@tbruyelle
Copy link
Contributor

Seeing that the deployment action is throwing an error relating to firebase credentials:

/home/ubuntu/actions/runner-0/_work/_actions/FirebaseExtended/action-hosting-deploy/v0/bin/action.min.js:274
[10](https://github.com/ignite/cli/actions/runs/3413507429/jobs/5680294482#step:7:11)
        throw new Error(`Input required and not supplied: ${name}`);
[11](https://github.com/ignite/cli/actions/runs/3413507429/jobs/5680294482#step:7:12)
        ^

I don't know why, maybe it's because the PR is originated from an external repo ?

@joshLong145
Copy link
Contributor Author

Seeing that the deployment action is throwing an error relating to firebase credentials:

/home/ubuntu/actions/runner-0/_work/_actions/FirebaseExtended/action-hosting-deploy/v0/bin/action.min.js:274
[10](https://github.com/ignite/cli/actions/runs/3413507429/jobs/5680294482#step:7:11)
        throw new Error(`Input required and not supplied: ${name}`);
[11](https://github.com/ignite/cli/actions/runs/3413507429/jobs/5680294482#step:7:12)
        ^

I don't know why, maybe it's because the PR is originated from an external repo ?

I think so, I can move it over to a branch from this repository.

@tbruyelle
Copy link
Contributor

@joshLong145 I'm working on a change to adapt the documentation with the latest changes of #3060, can you enable Allow edits from maintainers again please ?

@joshLong145
Copy link
Contributor Author

@joshLong145 I'm working on a change to adapt the documentation with the latest changes of #3060, can you enable Allow edits from maintainers again please ?

sure thing, I attempted to migrate the changes to their own branch off this repo but I don't have write access to the repository it seems.

@tbruyelle
Copy link
Contributor

@joshLong145 I'm working on a change to adapt the documentation with the latest changes of #3060, can you enable Allow edits from maintainers again please ?

sure thing, I attempted to migrate the changes to their own branch off this repo but I don't have write access to the repository it seems.

Thank you, I pushed the change. So the main changes are :

  • Commands and Hooks are merged into Manifest
  • Execute* methods now takes a single argument that gives access to command path, args and flags. It's now a different type (before Command and Hook were used for both definition and runtime, which could lead to confusion because of the different field context).

Concerning the doc, I revamped a little bit because we must mention ignite plugin scaffold which is very helpful to develop a plugin.

@joshLong145
Copy link
Contributor Author

should we migrate this to a branch directly off ignite to get deployment actions passing or just leave it how it is?

@tbruyelle
Copy link
Contributor

should we migrate this to a branch directly off ignite to get deployment actions passing or just leave it how it is?

I don't know, this is the first time I see this. Any idea @aljo242 or @ilgooz ?

@aljo242 aljo242 changed the base branch from develop to main November 15, 2022 13:51
@aljo242
Copy link
Contributor

aljo242 commented Nov 15, 2022

should we migrate this to a branch directly off ignite to get deployment actions passing or just leave it how it is?

I don't know, this is the first time I see this. Any idea @aljo242 or @ilgooz ?

Its fine to leave it as is

Copy link
Contributor

@tbruyelle tbruyelle left a comment

Choose a reason for hiding this comment

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

since I participated to this PR, it must have a second approval :)

@aljo242 aljo242 merged commit 4c53993 into ignite:main Nov 18, 2022
Jchicode pushed a commit to Jchicode/cli that referenced this pull request Aug 9, 2023
* addition of plugin docs

* updates to new plugin docs

* docs: update according to last interface changes

* remove private slack link

* docs: fix ExecuteHook* examples

Co-authored-by: Thomas Bruyelle <[email protected]>
Co-authored-by: Alex Johnson <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:docs Documentation additions or improvements. skip-changelog Don't check changelog for new entries
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document ignite plugin
4 participants