generated from SAP/repository-template
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Update README.md * feat: updated doc, set publisher to SAPOSS * fix: remove section for guide request Co-authored-by: Klaus Keller <klaus.keller@sap.com>
- Loading branch information
1 parent
22cb70c
commit 0357d66
Showing
4 changed files
with
33 additions
and
62 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
'sap-guided-answers-extension': patch | ||
--- | ||
|
||
Updated README.md and documentation, set publisher to SAPOSS |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,71 +1,26 @@ | ||
|
||
# Guided Answers extension by SAP | ||
|
||
|
||
### Description | ||
SAP’s Guided Answers (https://ga.support.sap.com/dtp/viewer/index.html) is an interactive documentation designed to help troubleshoot issues, navigate processes, and guide users through tasks via a series of questions. SAP experts document the exact steps for analysing issues and make that available to the customers.SAP's Guided Answers is recommended to customers to get the most from the support. Customers can look for solutions themselves instead of opening a customer support incident. | ||
|
||
This Guide Answers extension is an extension that renders content of already existing Guided Answers directly in the IDE (Integrated Developer Environment such as SAP Business Application Studio and VSCode), making the content interactive and context-aware within the IDE. Developers do not need to navigate back and forth between separate supporting materials and their IDE when they come across an issue. This extension improves and speeds up the support process for SAP tools and increases user satisfaction. It will also help support teams provide clearer and more accurate solutions to issues to their customers. | ||
|
||
### Requirements | ||
|
||
TBC | ||
|
||
### Installation | ||
|
||
From VSCode Market Place ( coming soon ) | ||
|
||
From Github | ||
1. | ||
|
||
### Updates | ||
|
||
By default, VS Code auto-updates extensions as new versions become available as explained in https://code.visualstudio.com/docs/supporting/faq#_how-do-i-opt-out-of-vs-code-autoupdates. If auto-update is disabled in your VS Code, you should update the extension manually to the latest version frequently to avoid supply-chain attack and other cyberattacks. | ||
|
||
### Usuage | ||
|
||
How to launch Guided Answer Extension within VSCode or SBAS | ||
|
||
1. Use Command Palette -> CMD/CTRL + Shift + P | ||
2. Type command -> SAP: Open Guided Answers | ||
|
||
How to launch Guided Answer Extension from within another extension in VSCode or SBAS | ||
|
||
1. Capture the Tree and Node Id from the Guide Answer's Guide URL that you wish to activate in the Guide Answers Extension | ||
|
||
https://ga.support.sap.com/dtp/viewer/index.html#/tree/**3046**/actions/**45995** | ||
|
||
2. Activate Guide Answer's Extension by passing the required tree and node id where extension error occurs | ||
How to add a new guide to SAP's Guided Answers | ||
[SAP’s Guided Answers](https://ga.support.sap.com/dtp/viewer/index.html) is an interactive documentation designed to help troubleshoot issues, navigate processes, and guide users through tasks via a series of questions. SAP experts document the exact steps for analyzing issues and make that available to the customers. SAP's Guided Answers is recommended to customers to get the most from the support. Customers can look for solutions themselves instead of opening a customer support incident. | ||
|
||
1. Navigate to https://ga.support.sap.com/dtp/viewer/ and click on 'Contact Us' | ||
` | ||
|
||
### How to Obtain Support | ||
|
||
Guided Answers Extension | ||
|
||
To get more help, support, and information about the Guided Answers Extension please open a github issue | ||
|
||
https://github.com/SAP/guided-answers-extension/issues/new?assignees=&labels=type%3Abug&template=bug_report.md&title=BUG+-+ | ||
|
||
SAP's Guided Answers Support | ||
|
||
To get more help, support and information about SAP's Guided Answer navigate to https://ga.support.sap.com/dtp/viewer/ and click on 'Contact Us' | ||
|
||
### How to Contribute | ||
|
||
This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/SAP/guided-answers-extension/issues). Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md). | ||
|
||
This Guided Answers extension by SAP renders content of already existing Guided Answers directly in an Integrated Developer Environment (IDE) such as SAP Business Application Studio (SBAS) and Microsoft Visual Studio Code (VSCode), making the content interactive and context-aware within the IDE. Developers do not need to navigate back and forth between separate supporting materials and their IDE when they come across an issue. This extension improves and speeds up the support process for SAP tools and increases user satisfaction. It will also help support teams provide clearer and more accurate solutions to issues to their customers. | ||
## Usage | ||
To launch Guided Answer Extension within VSCode or SBAS | ||
``` | ||
1. Use Command Palette -> CMD/CTRL + Shift + P | ||
2. Type command -> SAP: Open Guided Answers | ||
``` | ||
## Support | ||
If you have an issue with Guided Answers extension for SAP please open a [GitHub issue](https://github.com/SAP/guided-answers-extension/issues/new?assignees=&labels=type%3Abug&template=bug_report.md&title=BUG+-+). | ||
## Information for Developers | ||
This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/SAP/guided-answers-extension/issues). On GitHub you can also find information for developers including the project structure and extension features such as how to [call this extension from another extension](https://github.com/SAP/guided-answers-extension/blob/main/docs/technical-information.md#module-sap-guided-answer-extension-packageside-extension). | ||
|
||
Contribution and feedback are encouraged and always welcome. For more information about how to contribute as well as additional contribution information, see our [Contribution Guidelines](https://github.com/SAP/guided-answers-extension/blob/main/CONTRIBUTING.md). | ||
## Code of Conduct | ||
|
||
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its [Code of Conduct](CODE_OF_CONDUCT.md) at all times. | ||
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its [Code of Conduct](https://github.com/SAP/guided-answers-extension/blob/main/CODE_OF_CONDUCT.md) at all times. | ||
|
||
## Licensing | ||
|
||
Copyright (2022) SAP SE or an SAP affiliate company and `guided-answers-extension` contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/SAP/guided-answers-extension). | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters