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

Document the "application info" feature #10814

Closed
crenshaw-dev opened this issue Oct 5, 2022 · 4 comments · Fixed by #13351
Closed

Document the "application info" feature #10814

crenshaw-dev opened this issue Oct 5, 2022 · 4 comments · Fixed by #13351
Assignees
@26tanishabanik
Labels
enhancement New feature or request good first issue Good for newcomers hacktoberfest type:docs Missing or incomplete documentation

Comments

@crenshaw-dev
Copy link
Collaborator

Summary

There's an undocumented field in the Application spec which allows folks to add additional info to an Application details page.

Proposal

We could probably have a new page like the one for external links.

We should also document the field in the example application spec.
@crenshaw-dev crenshaw-dev added enhancement New feature or request good first issue Good for newcomers type:docs Missing or incomplete documentation hacktoberfest labels Oct 5, 2022
@26tanishabanik
Copy link

@crenshaw-dev , I would like to work on this issue

@26tanishabanik
Copy link

@crenshaw-dev , where should I start from for the documentation?

@crenshaw-dev
Copy link
Collaborator Author

@26tanishabanik check out the two links at the bottom of the issue. The first one shows a page that can be used as an example to create a new page in docs. After adding the page in the docs directory, you can test the docs with make serve-docs. The second link shows a file where examples of the feature can be added (that file is meant to document every possible field in the Application spec).

@Abhishek-569
Copy link

Hey @crenshaw-dev can I work on this issue since there is no update for last 4 months?

@Hapshanko Hapshanko mentioned this issue Apr 25, 2023
Merged
13 tasks
crenshaw-dev added a commit that referenced this issue Apr 28, 2023
@Hapshanko @crenshaw-dev
docs: Application Info field documentation (#10814) (#13351)
3dc809e 
* add Application info field documentation

Signed-off-by: Hapshanko <112761282+Hapshanko@users.noreply.github.com>

* Extra Application info docs

Signed-off-by: Hapshanko <112761282+Hapshanko@users.noreply.github.com>

* Added info field documentation

Signed-off-by: Hapshanko <112761282+Hapshanko@users.noreply.github.com>

* Add space to comment

Co-authored-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com>
Signed-off-by: Hapshanko <112761282+Hapshanko@users.noreply.github.com>

* docs: Add extra_info.md to table of contents

Signed-off-by: Hapshanko <112761282+Hapshanko@users.noreply.github.com>

---------

Signed-off-by: Hapshanko <112761282+Hapshanko@users.noreply.github.com>
Co-authored-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com>
gcp-cherry-pick-bot bot pushed a commit that referenced this issue Apr 28, 2023
@Hapshanko @crenshaw-dev
docs: Application Info field documentation (#10814) (#13351)
44d65ba 
* add Application info field documentation

Signed-off-by: Hapshanko <112761282+Hapshanko@users.noreply.github.com>

* Extra Application info docs

Signed-off-by: Hapshanko <112761282+Hapshanko@users.noreply.github.com>

* Added info field documentation

Signed-off-by: Hapshanko <112761282+Hapshanko@users.noreply.github.com>

* Add space to comment

Co-authored-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com>
Signed-off-by: Hapshanko <112761282+Hapshanko@users.noreply.github.com>

* docs: Add extra_info.md to table of contents

Signed-off-by: Hapshanko <112761282+Hapshanko@users.noreply.github.com>

---------

Signed-off-by: Hapshanko <112761282+Hapshanko@users.noreply.github.com>
Co-authored-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com>
@gcp-cherry-pick-bot gcp-cherry-pick-bot bot mentioned this issue Apr 28, 2023
Merged
gcp-cherry-pick-bot bot pushed a commit that referenced this issue Apr 28, 2023
@Hapshanko @crenshaw-dev
docs: Application Info field documentation (#10814) (#13351)
798a252 
* add Application info field documentation

Signed-off-by: Hapshanko <112761282+Hapshanko@users.noreply.github.com>

* Extra Application info docs

Signed-off-by: Hapshanko <112761282+Hapshanko@users.noreply.github.com>

* Added info field documentation

Signed-off-by: Hapshanko <112761282+Hapshanko@users.noreply.github.com>

* Add space to comment

Co-authored-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com>
Signed-off-by: Hapshanko <112761282+Hapshanko@users.noreply.github.com>

* docs: Add extra_info.md to table of contents

Signed-off-by: Hapshanko <112761282+Hapshanko@users.noreply.github.com>

---------

Signed-off-by: Hapshanko <112761282+Hapshanko@users.noreply.github.com>
Co-authored-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com>
This was referenced Apr 28, 2023
Merged
Merged
gcp-cherry-pick-bot bot pushed a commit that referenced this issue Apr 28, 2023
@Hapshanko @crenshaw-dev
docs: Application Info field documentation (#10814) (#13351)
bf5274a 
* add Application info field documentation

Signed-off-by: Hapshanko <112761282+Hapshanko@users.noreply.github.com>

* Extra Application info docs

Signed-off-by: Hapshanko <112761282+Hapshanko@users.noreply.github.com>

* Added info field documentation

Signed-off-by: Hapshanko <112761282+Hapshanko@users.noreply.github.com>

* Add space to comment

Co-authored-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com>
Signed-off-by: Hapshanko <112761282+Hapshanko@users.noreply.github.com>

* docs: Add extra_info.md to table of contents

Signed-off-by: Hapshanko <112761282+Hapshanko@users.noreply.github.com>

---------

Signed-off-by: Hapshanko <112761282+Hapshanko@users.noreply.github.com>
Co-authored-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com>
crenshaw-dev added a commit that referenced this issue May 1, 2023
@gcp-cherry-pick-bot @Hapshanko @crenshaw-dev
docs: Application Info field documentation (#10814) (#13351) (#13375)
3b866db 
* add Application info field documentation



* Extra Application info docs



* Added info field documentation



* Add space to comment




* docs: Add extra_info.md to table of contents



---------

Signed-off-by: Hapshanko <112761282+Hapshanko@users.noreply.github.com>
Co-authored-by: Hapshanko <112761282+Hapshanko@users.noreply.github.com>
Co-authored-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com>
crenshaw-dev added a commit that referenced this issue May 1, 2023
@gcp-cherry-pick-bot @Hapshanko @crenshaw-dev
docs: Application Info field documentation (#10814) (#13351) (#13377)
a707ab6 
* add Application info field documentation



* Extra Application info docs



* Added info field documentation



* Add space to comment




* docs: Add extra_info.md to table of contents



---------

Signed-off-by: Hapshanko <112761282+Hapshanko@users.noreply.github.com>
Co-authored-by: Hapshanko <112761282+Hapshanko@users.noreply.github.com>
Co-authored-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com>
crenshaw-dev added a commit that referenced this issue May 1, 2023
@gcp-cherry-pick-bot @Hapshanko @crenshaw-dev
docs: Application Info field documentation (#10814) (#13351) (#13376)
f083756 
* add Application info field documentation



* Extra Application info docs



* Added info field documentation



* Add space to comment




* docs: Add extra_info.md to table of contents



---------

Signed-off-by: Hapshanko <112761282+Hapshanko@users.noreply.github.com>
Co-authored-by: Hapshanko <112761282+Hapshanko@users.noreply.github.com>
Co-authored-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com>
schakrad pushed a commit to schakrad/argo-cd that referenced this issue Jul 24, 2023
@gcp-cherry-pick-bot @Hapshanko
@crenshaw-dev @schakrad
docs: Application Info field documentation (argoproj#10814) (argoproj…
ab18e4a 
…#13351) (argoproj#13377)

* add Application info field documentation

* Extra Application info docs

* Added info field documentation

* Add space to comment

* docs: Add extra_info.md to table of contents

---------

Signed-off-by: Hapshanko <112761282+Hapshanko@users.noreply.github.com>
Co-authored-by: Hapshanko <112761282+Hapshanko@users.noreply.github.com>
Co-authored-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com>
Signed-off-by: schakrad <58915923+schakrad@users.noreply.github.com>
yyzxw pushed a commit to yyzxw/argo-cd that referenced this issue Aug 9, 2023
@Hapshanko @crenshaw-dev
docs: Application Info field documentation (argoproj#10814) (argoproj…
2cb29c5 
…#13351)

* add Application info field documentation

Signed-off-by: Hapshanko <112761282+Hapshanko@users.noreply.github.com>

* Extra Application info docs

Signed-off-by: Hapshanko <112761282+Hapshanko@users.noreply.github.com>

* Added info field documentation

Signed-off-by: Hapshanko <112761282+Hapshanko@users.noreply.github.com>

* Add space to comment

Co-authored-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com>
Signed-off-by: Hapshanko <112761282+Hapshanko@users.noreply.github.com>

* docs: Add extra_info.md to table of contents

Signed-off-by: Hapshanko <112761282+Hapshanko@users.noreply.github.com>

---------

Signed-off-by: Hapshanko <112761282+Hapshanko@users.noreply.github.com>
Co-authored-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@26tanishabanik 26tanishabanik

Labels
enhancement New feature or request good first issue Good for newcomers hacktoberfest type:docs Missing or incomplete documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: Application Info field documentation (#10814) Hapshanko/argo-cd
3 participants
@crenshaw-dev @26tanishabanik @Abhishek-569