From e9ced9d545ca9f05508294b184be071e5e469335 Mon Sep 17 00:00:00 2001 From: Thomas Prouvot Date: Mon, 18 Sep 2023 10:03:40 +0200 Subject: [PATCH 01/11] Add badges --- docs/index.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 4df43380..e4cceac4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,11 @@ -# Home +# Salesforce Inspector Reloaded Documentation + +![GitHub release](https://img.shields.io/github/v/release/tprouvot/Salesforce-Inspector-reloaded?sort=semver) +[![Chrome Web Store Installs](https://img.shields.io/chrome-web-store/users/hpijlohoihegkfehhibggnkbjhoemldh)](https://chrome.google.com/webstore/detail/salesforce-inspector-relo/hpijlohoihegkfehhibggnkbjhoemldh) +[![Chrome Web Store Rating](https://img.shields.io/chrome-web-store/rating/hpijlohoihegkfehhibggnkbjhoemldh)](https://chrome.google.com/webstore/detail/salesforce-inspector-relo/hpijlohoihegkfehhibggnkbjhoemldh) +[![GitHub stars](https://img.shields.io/github/stars/tprouvot/Salesforce-Inspector-reloaded?cacheSeconds=3600)](https://github.com/tprouvot/Salesforce-Inspector-reloaded/stargazers/) +[![GitHub contributors](https://img.shields.io/github/contributors/tprouvot/Salesforce-Inspector-reloaded.svg)](https://github.com/tprouvot/Salesforce-Inspector-reloaded/graphs/contributors/) +[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) Extension based on [Salesforce Inspector](https://github.com/sorenkrabbe/Chrome-Salesforce-inspector) by Søren Krabbe. From 6f792c41d29f6249c35ac9974bc4e20ab3184eac Mon Sep 17 00:00:00 2001 From: Thomas Prouvot Date: Mon, 18 Sep 2023 11:03:41 +0200 Subject: [PATCH 02/11] Update documentation --- CHANGES.md | 426 ++++++------------------------------------- docs/index.md | 58 +++--- docs/release-note.md | 86 +-------- mkdocs.yml | 4 +- 4 files changed, 94 insertions(+), 480 deletions(-) diff --git a/CHANGES.md b/CHANGES.md index 2d8f89e0..489a26bc 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,383 +1,73 @@ -Version 1.19 -=========== +# Release Notes -General -------- +## Version 1.19 -* Inspect Page Restyling (UI improvements, red background for PROD, display / hide table borders) [PR105](https://github.com/tprouvot/Salesforce-Inspector-reloaded/pull/105) (contribution by [Pietro Martino](https://github.com/pietromartino)) -* Navigate to record detail (Flows, Profiles and PermissionSet) from shortcut search [feature 118](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/118) -* Fix country codes from LocalSidKey convention [PR117](https://github.com/tprouvot/Salesforce-Inspector-reloaded/pull/117) (contribution by [Luca Bassani](https://github.com/baslu93)) -* Use custom shortcuts [feature 115](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/115) -* Add Export Query button [feature 109](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/109) (idea by [Ryan Sherry](https://github.com/rpsherry-starburst)) -* Add permission set group assignment button from popup [feature 106](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/106) +- Inspect Page Restyling (UI improvements, red background for PROD, display / hide table borders) [PR105](https://github.com/tprouvot/Salesforce-Inspector-reloaded/pull/105) (contribution by [Pietro Martino](https://github.com/pietromartino)) +- Navigate to record detail (Flows, Profiles and PermissionSet) from shortcut search [feature 118](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/118) +- Fix country codes from LocalSidKey convention [PR117](https://github.com/tprouvot/Salesforce-Inspector-reloaded/pull/117) (contribution by [Luca Bassani](https://github.com/baslu93)) +- Use custom shortcuts [feature 115](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/115) +- Add Export Query button [feature 109](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/109) (idea by [Ryan Sherry](https://github.com/rpsherry-starburst)) +- Add permission set group assignment button from popup [feature 106](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/106) -Version 1.18 -=========== +## Version 1.18 -General -------- -* Update to Salesforce API v 58.0 (Summer '23) -* Restyle popup with SLDS (Salesforce Lightning Design System) [feature 9](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/9) (idea by [Loïc BERBEY](https://github.com/lberbey), contribution by [Pietro Martino](https://github.com/pietromartino)) -* Fix "Show all data" shortcut from popup [issue 96](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/96) (fix by [Pietro Martino](https://github.com/pietromartino)) +- Update to Salesforce API v 58.0 (Summer '23) +- Restyle popup with SLDS (Salesforce Lightning Design System) [feature 9](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/9) (idea by [Loïc BERBEY](https://github.com/lberbey), contribution by [Pietro Martino](https://github.com/pietromartino)) +- Fix "Show all data" shortcut from popup [issue 96](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/96) (fix by [Pietro Martino](https://github.com/pietromartino)) -Version 1.17 -=========== +## Version 1.17 -General -------- -* Add toLabel function among autocomplete query suggestions [feature 90](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/90) (idea by [Mickael Gudin](https://github.com/mickaelgudin)) -* Update spinner on inspect page when loading or saving records and disable button [feature 69](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/69) (idea by [Camille Guillory](https://github.com/CamilleGuillory)) -* Show "Copy Id" from Inspect page [feature 12](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/12) -* Add a configuration option for links to open in a new tab [feature 78](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/78) (idea by [Henri Vilminko](https://github.com/hvilminko)) -* Import data as JSON [feature 75](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/75) (idea by [gaelguimini](https://github.com/gaelguimini)) -* Fix auto update action on data import [issue 73](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/73) (issue by [Juul1](https://github.com/Juul1)) -* Restore focus on suggested fields when pressing tab key in query editor [issue 66](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/66) (idea by [Enrique Muñoz](https://github.com/emunoz-at-wiris)) -* Update shortcut indication for mac users -* Fix links for custom object [PR80](https://github.com/tprouvot/Salesforce-Inspector-reloaded/pull/80) (contribution by [Mouloud Habchi](https://github.com/MD931)) -* Fix links for custom setting [PR82](https://github.com/tprouvot/Salesforce-Inspector-reloaded/pull/82) (contribution by [Mouloud Habchi](https://github.com/MD931)) +- Add toLabel function among autocomplete query suggestions [feature 90](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/90) (idea by [Mickael Gudin](https://github.com/mickaelgudin)) +- Update spinner on inspect page when loading or saving records and disable button [feature 69](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/69) (idea by [Camille Guillory](https://github.com/CamilleGuillory)) +- Show "Copy Id" from Inspect page [feature 12](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/12) +- Add a configuration option for links to open in a new tab [feature 78](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/78) (idea by [Henri Vilminko](https://github.com/hvilminko)) +- Import data as JSON [feature 75](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/75) (idea by [gaelguimini](https://github.com/gaelguimini)) +- Fix auto update action on data import [issue 73](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/73) (issue by [Juul1](https://github.com/Juul1)) +- Restore focus on suggested fields when pressing tab key in query editor [issue 66](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/66) (idea by [Enrique Muñoz](https://github.com/emunoz-at-wiris)) +- Update shortcut indication for mac users +- Fix links for custom object [PR80](https://github.com/tprouvot/Salesforce-Inspector-reloaded/pull/80) (contribution by [Mouloud Habchi](https://github.com/MD931)) +- Fix links for custom setting [PR82](https://github.com/tprouvot/Salesforce-Inspector-reloaded/pull/82) (contribution by [Mouloud Habchi](https://github.com/MD931)) -Version 1.16 -=========== +## Version 1.16 -General -------- -* Select "Update" action by default when the data paste in data-import page contains Id column [feature 60](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/60) (idea by Bilel Morsli) -* Allow users to update API Version [feature 58](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/58) -* Add org instance in the popup and a link to Salesforce trust status website [feature 53](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/53) (idea by [Camille Guillory](https://github.com/CamilleGuillory) ) -* Fix saved query when it contains ":" [issue 55](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/55) (bug found by [Victor Garcia](https://github.com/victorgz/) ) +- Select "Update" action by default when the data paste in data-import page contains Id column [feature 60](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/60) (idea by Bilel Morsli) +- Allow users to update API Version [feature 58](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/58) +- Add org instance in the popup and a link to Salesforce trust status website [feature 53](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/53) (idea by [Camille Guillory](https://github.com/CamilleGuillory) ) +- Fix saved query when it contains ":" [issue 55](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/55) (bug found by [Victor Garcia](https://github.com/victorgz/) ) -Version 1.15 -=========== +## Version 1.15 -General -------- -* Add "PSet" button to access user permission set assignment from User tab [feature 49](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/49) -* Add shortcut tab to access setup quick links [feature 42](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/42) +- Add "PSet" button to access user permission set assignment from User tab [feature 49](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/49) +- Add shortcut tab to access setup quick links [feature 42](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/42) -Version 1.14 -=========== +## Version 1.14 -General -------- -* Add checkbox in flow builder to give the possibility to the user to scroll on the flow (by [Samuel Krissi](https://github.com/samuelkrissi) ) +- Add checkbox in flow builder to give the possibility to the user to scroll on the flow (by [Samuel Krissi](https://github.com/samuelkrissi) ) ![image](https://user-images.githubusercontent.com/96471586/226161542-cbedec0a-8988-4559-9152-d067ea6f9cb6.png) -* Fix links (object fields and object list) for custom metadata objects [issue 39](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/39) -* Add shortcut link to object list from popup (idea by [Samuel Krissi](https://github.com/samuelkrissi) ) -* Add shortcuts links to (list of record types, current SObject RecordType and objet details, show all data from user tab) from popup [feature 34](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/34) -* Update manifest version from [v2](https://developer.chrome.com/docs/extensions/mv3/mv2-sunset/) to v3 -* Auto detect SObject on import page when posting data which contain SObject header [feature 30](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/30) -* Update to Salesforce API v 57.0 (Spring '23) -* [Switch background color on import page to alert users that it's a production environnement](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/20) -* Implement Auth2 flow to generate access token for connected App - -Version 1.13 -=========== - -General -------- -* [Automatically remove spaces from column name in import](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/23) -* Update to Salesforce API v 56.0 (Winter '23) -* Add "Skip all unknown fields" to import page -* Add User Id to pop-up - -Inspector menu - -* Support Enhanced Domain [issue #222](https://github.com/sorenkrabbe/Chrome-Salesforce-inspector/issues/222) from [PR223](https://github.com/sorenkrabbe/Chrome-Salesforce-inspector/pull/223) -* [Add inactive users to search result](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/21) - -Inspector menu - -* Update to Salesforce API v 55.0 (Summer '22) -* Update to Salesforce API v 54.0 (Spring '22) -* [Sticked table header to the top on export](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/10) -* Update to Salesforce API v 53.0 (Winter '22) -* Add label to saved query and sort list. -* Remove extra comma when autocomplete query in data export, or select a field from suggested fields juste before 'FROM' keyword. - -Inspector menu - -* Add "Copy Id" option when clicking on a Sobject field or Id in data export page. - -Inspector menu - -* Integrate UI updates from [Garywoo's fork](https://github.com/Garywoo/Chrome-Salesforce-inspector) - -Version 1.12 -=========== - -General -------- -* Update to Salesforce API v 51.0 (Spring '21) - -Version 1.11 -=========== - -General -------- -* Make inspector available on Visualforce pages on new visualforce.com domain. See #143 - -Org Limits ----------- -* Displays "consumed" count - -Version 1.10 -=========== - -General -------- -* Update to Salesforce API v 48.0 - -Version 1.9 -=========== - -Inspector menu --------------- -* Fix a bug fix hiding the "show field metadata" button (#150) - -Version 1.8 -=========== - -Inspector menu --------------- -* Added user search aspect to simplify access to detailed user data and "login as". - -Version 1.7 -=========== - -General -------- -* Update to Salesforce API v 47.0 - -Inspector menu --------------- -* A new link to switch in and out of Salesforce Setup, where you can choose to open in a new tab or not. - -Show all data -------------- -* Fixed a bug causing errors when viewing some special objects. -* Link to Salesforce Setup in both Classic and Lightning Experience. -* Use default values for blank fields when creating a new record. This avoids the error message that OwnerId is required but missing. - -Data import ------------ -* Save import options in your excel sheet, so you can update the same data again and again with a single copy-paste. - - -Version 1.6 -=========== - -General -------- -* Update to Salesforce API v 45.0 -* Support for cloudforce.com orgs - -Show all data -------------- -* Buttons to Create, delete and clone records - -Data export ------------ -* Keyboard shortcut to do export (ctrl+enter) -* Fixes saved query selection - -Data import ------------ -* Wider import fields - -Version 1.5 -=========== - -General -------- -* Update to Salesforce API v 43.0 - -Inspector menu --------------- -* Show record details - currently for objects with record types only -* Link to LEX object manager/setup for object in focus - -Version 1.4 -=========== - -Inspector menu --------------- -* Support for Spring '18 LEX URL format (https://docs.releasenotes.salesforce.com/en-us/spring18/release-notes/rn_general_enhanced_urls_cruc.htm) - -Version 1.3 -=========== - -General -------- -* Rewritten the implementation of Data Export and Data Import, in order to comply with the updated version of Mozilla's add-ons policy. -* Rewritten the implementation of Data Export and Data Import, in order to comply with the updated version of Mozilla's add-ons policy. - -Version 1.2 -=========== - -General -------- -* Update API versoin to Spring 17. - -Inspector menu --------------- -* Use the autocomplete to find object API names, labels and ID prefixes. -* View some information about the selected record or object directly in the menu. -* Inspect objects in the Tooling API and objects you don't have read access to. -* When viewing a Deployment Status, a new button allows you to get all the details of the deployment. -* The Explore API button is now visible everywhere. - -Show all data -------------- -* The Type column has more information. (required, unique, auto number etc.) -* Add your own columns, (for example a column showing the formula of formula fields, or a collumn that tells which fields can be used as a filter.) for both fields and relationships. -* The "Advanced filter" option is more discoverable now. -* New button to start data export for the shown object. -* New button to edit the page layout for the shown record. -* Better handling of objects that share a common ID prefix or is available with both the regular API and the Tooling API. - -Data export ------------ -* Save your favourite SOQL queries. -* The query history remembers if queries were done with the Tooling API or not. -* Fixed right clicking on IDs in the exported data. - -Data import ------------ -* Fix for importing data from Excel on Mac into Chrome. - -Org Limits ----------- -* View how much of your org's limits you are currently using. - -Download Metadata ------------------ -* Download all your org's Apex classes, Visualforce pages, objects, fields, validation rules, workflow rules, reports and much more. Use it for backup, or if you want to search for any place a particular item is used, or for many other purposes. - -API Explorer ------------- -* Choose between showing the result for easy viewing or for easy copying. -* Make SOAP requests. -* Make REST requests for any HTTP method. -* Edit any API request before sending. - -Version 1.1 -============ - -General -------- -* Update API versoin to Winter 17. -* Find the current page's record ID for Visualforce pages that store the record ID in a non-standard parameter name. - -Data import ------------ -* Don't make describe calls in an infinite loop when Salesforce returns an error (Salesforce Winter 17 Tooling API has a number objects starting with autogen__ that don't work properly). - -Version 1.0 -============ - -General -------- -* The Inspector is now shown in regular tabs instead of popups. You can now choose if you want to open a link in the same tab (the default), or a new tab/window, using normal browser menus and shortcuts. Previously every link opened a new popup window. -* Restyled the Inspector menu to use Lightning Design. Restyling the rest will come later. -* Switched to a more robust API for getting the Salesforce session ID. It now works with all session security settings, and it works in Lightning Experience. -* Added a logo/icon. -* The salesforce hostname is now visible as a parameter in the URL bar. -* If you have an outdated browser version that is not supported by the latest version of Salesforce Inspector, Salesforce Inspector will not autoupdate. -* Updated API version to Summer 16. - -Show all data -------------- -* When copy-pasting a value, there is no longer extra white-space at the beginning and end of the copied text. - -Data import ------------ -* Ask for confirmation before closing an in-progress data import. -* Tweaks to how batch concurrency/threads work. - -Data export ------------ -* If an error occurs during a data export, we now keep the data that is already exported. - -Known Issues ------------- -* When using Firefox, it no longer works in Private Browsing mode, since it cannot get the Salesforce session ID. See https://bugzilla.mozilla.org/show_bug.cgi?id=1254221 . - -Version 0.10 -============ - -General -------- -* Update API version to Spring 16. - -Show all data -------------- -* Show information about the page layout of the inspected record. -* Make quick value selection work in Chrome again. - -Data export ------------ -* Make record IDs clickable in the result table, in adition to object names. -* Offer to either view all data for a record or view the record in normal Salesforce UI. -* Fix bug opening the all data window when exporting with the Tooling API. -* Fix keyboard shortcut issue in some variations of Chrome. - -Data import ------------ -* Make record IDs clickable in the status table. - -API explorer ------------- -* Display results as a table instead of CSV. - -Version 0.9 -=========== - -General -------- -* Show the inspector menu in the inspector's own windows. -* Better handling of network errors and errors returned by the Salesforce API. - -Show field metadata -------------------- -* Fix viewing field metadata for a Visualforce page. - -Show all data -------------- -* Show the object/record input field everywhere instead of only in the developer console. -* Fix "setup" links for person accounts and for orgs with many custom fields. -* Allow editing only specific fields of a record, and refresh the data after saving. -* Improve selection. - -Data export ------------ -* Support autocomplete for subqueries in the where clause. -* Sort the autocomplete results by relevance. -* Implement filtering of results (since browser search does not play nice with our lazy rendering). - -Data import ------------ -* Rewrite UI to be more guided. -* Graphical display of import status. -* Support for the tooling API. - -Version 0.8 -=========== - -General -------- -* Works in the service cloud console in Chrome (worked previously only in Firefox). -* Uses new extension API for Firefox (requires Firefox 44). -* Partial support for Salesforce1/Lightning. -* Update API version to Winter 16. - -Data export ------------ -* New simplified layout, that can handle larger amounts of data. - -Show all data -------------- -* Allow opening the All Data window for any object or record from the developer console. -* Ability to show help text and description. -* Work around a bug in the tooling API introduced in Winter 16. +- Fix links (object fields and object list) for custom metadata objects [issue 39](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/39) +- Add shortcut link to object list from popup (idea by [Samuel Krissi](https://github.com/samuelkrissi) ) +- Add shortcuts links to (list of record types, current SObject RecordType and objet details, show all data from user tab) from popup [feature 34](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/34) +- Update manifest version from [v2](https://developer.chrome.com/docs/extensions/mv3/mv2-sunset/) to v3 +- Auto detect SObject on import page when posting data which contain SObject header [feature 30](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/30) +- Update to Salesforce API v 57.0 (Spring '23) +- [Switch background color on import page to alert users that it's a production environnement](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/20) +- Implement Auth2 flow to generate access token for connected App + +## Version 1.13 + +- [Automatically remove spaces from column name in import](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/23) +- Update to Salesforce API v 56.0 (Winter '23) +- Add "Skip all unknown fields" to import page +- Add User Id to pop-up +- Support Enhanced Domain [issue #222](https://github.com/sorenkrabbe/Chrome-Salesforce-inspector/issues/222) from [PR223](https://github.com/sorenkrabbe/Chrome-Salesforce-inspector/pull/223) +- [Add inactive users to search result](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/21) +- Update to Salesforce API v 55.0 (Summer '22) +- Update to Salesforce API v 54.0 (Spring '22) +- [Sticked table header to the top on export](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/10) +- Update to Salesforce API v 53.0 (Winter '22) +- Add label to saved query and sort list. +- Remove extra comma when autocomplete query in data export, or select a field from suggested fields just before 'FROM' keyword. +- Add "Copy Id" option when clicking on a SObject field or Id in data export page. +- Integrate UI updates from [Garywoo's fork](https://github.com/Garywoo/Chrome-Salesforce-inspector) diff --git a/docs/index.md b/docs/index.md index e4cceac4..27e2cd93 100644 --- a/docs/index.md +++ b/docs/index.md @@ -13,18 +13,18 @@ Chrome and Firefox extension to add a metadata layout on top of the standard Sal ## Release Note -[List of changes](CHANGES.md) +[List of changes](/release-note) -## New Features +## Best Features -* Allow users to update API Version [feature 58](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/58) -* Add new "Shortcuts" tab to accelerate setup navigation [feature 42](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/42) -* Add shortcuts links to (list of record types, current SObject RecordType and objet details, show all data from user tab) from popup [feature 34](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/34) -* Control access to Salesforce Inspector reloaded with profiles / permissions (Implement Auth2 flow to generate access token for connected App) [how to](https://github.com/tprouvot/Salesforce-Inspector-reloaded/wiki/How-to#use-sf-inspector-with-a-connected-app) -* Update manifest version from [v2](https://developer.chrome.com/docs/extensions/mv3/mv2-sunset/) to v3 (extensions using manifest v2 will be removed from the store) -* New UI for Export / Import +- Add new "Shortcuts" tab to navigate to setup, Profiles, Permission Sets and Flows ! +- Add shortcuts links to (list of record types, current SObject RecordType and objet details, show all data from user tab) from popup [feature 34](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/34) +- Control access to Salesforce Inspector reloaded with profiles / permissions (Implement Auth2 flow to generate access token for connected App) [how to](https://github.com/tprouvot/Salesforce-Inspector-reloaded/wiki/How-to#use-sf-inspector-with-a-connected-app) +- Update manifest version from [v2](https://developer.chrome.com/docs/extensions/mv3/mv2-sunset/) to v3 (extensions using manifest v2 will be removed from the store) +- New UI for Export / Import ## Security and Privacy + The Salesforce Inspector browser extension/plugin communicates directly between the user's web browser and the Salesforce servers. No data is sent to other parties and no data is persisted outside of Salesforce servers after the user leaves the Salesforce Inspector pages. The Inspector communicates via the official Salesforce webservice APIs on behalf of the currently logged in user. This means the Inspector will be capable of accessing nothing but the data and features the user has been granted access to in Salesforce. @@ -37,6 +37,7 @@ To validate the accuracy of this description, inspect the source code, monitor t Follow steps described in [wiki](https://github.com/tprouvot/Salesforce-Inspector-reloaded/wiki/How-to#use-sf-inspector-with-a-connected-app) ## Installation + From the Chrome Web Store : [Salesforce Inspector reloaded](https://chrome.google.com/webstore/detail/salesforce-inspector-relo/hpijlohoihegkfehhibggnkbjhoemldh) If you want to try it locally (to test the release candidate): @@ -50,8 +51,8 @@ If you want to try it locally (to test the release candidate): ## Troubleshooting -* If Salesforce Inspector is not available after installation, the most likely issue is that your browser is not up to date. See [instructions for Google Chrome](https://productforums.google.com/forum/#!topic/chrome/YK1-o4KoSjc). -* When you enable the My Domain feature in Salesforce, Salesforce Inspector may not work until you have restarted your browser (or until you have deleted the "sid" cookie for the old Salesforce domain by other means). +- If Salesforce Inspector is not available after installation, the most likely issue is that your browser is not up to date. See [instructions for Google Chrome](https://productforums.google.com/forum/#!topic/chrome/YK1-o4KoSjc). +- When you enable the My Domain feature in Salesforce, Salesforce Inspector may not work until you have restarted your browser (or until you have deleted the "sid" cookie for the old Salesforce domain by other means). ## Development @@ -59,6 +60,7 @@ If you want to try it locally (to test the release candidate): 2. `npm install` ### Chrome + 1. `npm run chrome-dev-build` 2. Open `chrome://extensions/`. 3. Enable `Developer mode`. @@ -75,10 +77,10 @@ If you want to try it locally (to test the release candidate): ## Unit tests 1. Set up an org (e.g. a Developer Edition) and apply the following customizations: - 1. Everything described in metadata in `test/`. Push to org with `sfdx force:source:deploy -p test/ -u [your-test-org-alias]` - 2. Ensure _Allow users to relate a contact to multiple accounts_ is enabled (Setup→Account Settings) - 3. Ensure the org has no _namespace prefix_ (Setup→Package Manager) - 4. Assign PermissionSet SfInspector + 1. Everything described in metadata in `test/`. Push to org with `sfdx force:source:deploy -p test/ -u [your-test-org-alias]` + 2. Ensure _Allow users to relate a contact to multiple accounts_ is enabled (Setup→Account Settings) + 3. Ensure the org has no _namespace prefix_ (Setup→Package Manager) + 4. Assign PermissionSet SfInspector 2. Navigate to one of the extension pages and replace the file name with `test-framework.html`, for example `chrome-extension://example/test-framework.html?host=example.my.salesforce.com`. 3. Wait until "Salesforce Inspector unit test finished successfully" is shown. 4. If the test fails, open your browser's developer tools console to see error messages. @@ -87,8 +89,8 @@ If you want to try it locally (to test the release candidate): 1. `npm run eslint` -Release -------- +## Release + Version number must be manually incremented in [addon/manifest-template.json](addon/manifest-template.json) file ### Chrome @@ -101,21 +103,25 @@ If the version number is greater than the version currently in Chrome Web Store, 2. Upload the file from `target/firefox/firefox-release-build.zip` to addons.mozilla.org ## Design Principles ------ + +--- + (we don't live up to all of them. pull requests welcome) -* Stay completely inactive until the user explicitly interacts with it. The tool has the potential to break Salesforce functionality when used, since we rely on monkey patching and internal APIs. We must ensure that you cannot break Salesforce just by having the tool installed or enabled. For example, we won't fix the setup search placeholder bug. -* For manual ad-hoc tasks only. The tool is designed to help administrators and developers interact with Salesforce in the browser. It is after all a browser add-on. Enabling automation is a non-goal. -* User experience is important. Features should be intuitive and discoverable, but efficiency is more important than discoverability. More advanced features should be hidden, and primary features should be central. Performance is key. -* Automatically provide as much contextual information as possible, without overwhelming the user. Information that is presented automatically when needed is a lot more useful than information you need to explicitly request. For example, provide autocomplete for every input. -* Provide easy access to the raw Salesforce API. Enhance the interaction in a way that does not break the core use case, if our enhancements fails. For example, ensure we can display the result of a data export even if we cannot parse the SOQL query. -* It is fine to implement features that are already available in the core Salesforce UI, if we can make it easier, smarter or faster. -* Ensure that it works for as many users as possible. (for system administrators, for standard users, with person accounts, with multi currency, with large data volumes, with professional edition, on a slow network etc.) -* Be conservative about the number and complexity of Salesforce API requests we make, but don't sacrifice the other principles to do so. -* Focus on system administrators, developers and integrators. + +- Stay completely inactive until the user explicitly interacts with it. The tool has the potential to break Salesforce functionality when used, since we rely on monkey patching and internal APIs. We must ensure that you cannot break Salesforce just by having the tool installed or enabled. For example, we won't fix the setup search placeholder bug. +- For manual ad-hoc tasks only. The tool is designed to help administrators and developers interact with Salesforce in the browser. It is after all a browser add-on. Enabling automation is a non-goal. +- User experience is important. Features should be intuitive and discoverable, but efficiency is more important than discoverability. More advanced features should be hidden, and primary features should be central. Performance is key. +- Automatically provide as much contextual information as possible, without overwhelming the user. Information that is presented automatically when needed is a lot more useful than information you need to explicitly request. For example, provide autocomplete for every input. +- Provide easy access to the raw Salesforce API. Enhance the interaction in a way that does not break the core use case, if our enhancements fails. For example, ensure we can display the result of a data export even if we cannot parse the SOQL query. +- It is fine to implement features that are already available in the core Salesforce UI, if we can make it easier, smarter or faster. +- Ensure that it works for as many users as possible. (for system administrators, for standard users, with person accounts, with multi currency, with large data volumes, with professional edition, on a slow network etc.) +- Be conservative about the number and complexity of Salesforce API requests we make, but don't sacrifice the other principles to do so. +- Focus on system administrators, developers and integrators. ## About By Thomas Prouvot and forked from [Søren Krabbe and Jesper Kristensen](https://github.com/sorenkrabbe/Chrome-Salesforce-inspector) ## License + [MIT](./LICENSE) diff --git a/docs/release-note.md b/docs/release-note.md index 1f465fb5..38232137 100644 --- a/docs/release-note.md +++ b/docs/release-note.md @@ -1,85 +1 @@ -# Release Notes - -## Version 1.19 - -- Inspect Page Restyling (UI improvements, red background for PROD, display / hide table borders) [PR105](https://github.com/tprouvot/Salesforce-Inspector-reloaded/pull/105) (contribution by [Pietro Martino](https://github.com/pietromartino)) -- Navigate to record detail (Flows, Profiles and PermissionSet) from shortcut search [feature 118](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/118) -- Fix country codes from LocalSidKey convention [PR117](https://github.com/tprouvot/Salesforce-Inspector-reloaded/pull/117) (contribution by [Luca Bassani](https://github.com/baslu93)) -- Use custom shortcuts [feature 115](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/115) -- Add Export Query button [feature 109](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/109) (idea by [Ryan Sherry](https://github.com/rpsherry-starburst)) -- Add permission set group assignment button from popup [feature 106](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/106) - -## Version 1.18 - -- Update to Salesforce API v 58.0 (Summer '23) -- Restyle popup with SLDS (Salesforce Lightning Design System) [feature 9](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/9) (idea by [Loïc BERBEY](https://github.com/lberbey), contribution by [Pietro Martino](https://github.com/pietromartino)) -- Fix "Show all data" shortcut from popup [issue 96](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/96) (fix by [Pietro Martino](https://github.com/pietromartino)) - -## Version 1.17 - -- Add toLabel function among autocomplete query suggestions [feature 90](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/90) (idea by [Mickael Gudin](https://github.com/mickaelgudin)) -- Update spinner on inspect page when loading or saving records and disable button [feature 69](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/69) (idea by [Camille Guillory](https://github.com/CamilleGuillory)) -- Show "Copy Id" from Inspect page [feature 12](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/12) -- Add a configuration option for links to open in a new tab [feature 78](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/78) (idea by [Henri Vilminko](https://github.com/hvilminko)) -- Import data as JSON [feature 75](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/75) (idea by [gaelguimini](https://github.com/gaelguimini)) -- Fix auto update action on data import [issue 73](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/73) (issue by [Juul1](https://github.com/Juul1)) -- Restore focus on suggested fields when pressing tab key in query editor [issue 66](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/66) (idea by [Enrique Muñoz](https://github.com/emunoz-at-wiris)) -- Update shortcut indication for mac users -- Fix links for custom object [PR80](https://github.com/tprouvot/Salesforce-Inspector-reloaded/pull/80) (contribution by [Mouloud Habchi](https://github.com/MD931)) -- Fix links for custom setting [PR82](https://github.com/tprouvot/Salesforce-Inspector-reloaded/pull/82) (contribution by [Mouloud Habchi](https://github.com/MD931)) - -## Version 1.16 - -- Select "Update" action by default when the data paste in data-import page contains Id column [feature 60](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/60) (by Bilel Morsli) -- Allow users to update API ## Version [feature 58](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/58) -- Add org instance in the popup and a link to Salesforce trust status website [feature 53](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/53) (by [Camille Guillory](https://github.com/CamilleGuillory) ) -- Fix saved query when it contains ":" [issue 55](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/55) (by [Victor Garcia](https://github.com/victorgz/) ) - -## Version 1.15 - -- Add "PSet" button to access user permission set assignment from User tab [feature 49](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/49) -- Add shortcut tab to access setup quick links [feature 42](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/42) - -## Version 1.14 - -- Add checkbox in flow builder to give the possibility to the user to scroll on the flow (by [Samuel Krissi](https://github.com/samuelkrissi) ) - -![image](https://user-images.githubusercontent.com/96471586/226161542-cbedec0a-8988-4559-9152-d067ea6f9cb6.png) - -- Fix links (object fields and object list) for custom metadata objects [issue 39](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/39) -- Add shortcut link to object list from popup (idea by [Samuel Krissi](https://github.com/samuelkrissi) ) -- Add shortcuts links to (list of record types, current SObject RecordType and objet details, show all data from user tab) from popup [feature 34](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/34) -- Update manifest ## Version from [v2](https://developer.chrome.com/docs/extensions/mv3/mv2-sunset/) to v3 -- Auto detect SObject on import page when posting data which contain SObject header [feature 30](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/30) -- Update to Salesforce API v 57.0 (Spring '23) -- [Switch background color on import page to alert users that it's a production environnement](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/20) -- Implement Auth2 flow to generate access token for connected App - -## Version 1.13 - -- [Automatically remove spaces from column name in import](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/23) -- Update to Salesforce API v 56.0 (Winter '23) -- Add "Skip all unknown fields" to import page -- Add User Id to pop-up - -Add user - -- Support Enhanced Domain [issue #222](https://github.com/sorenkrabbe/Chrome-Salesforce-inspector/issues/222) from [PR223](https://github.com/sorenkrabbe/Chrome-Salesforce-inspector/pull/223) -- [Add inactive users to search result](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/21) - -Inspector menu - -- Update to Salesforce API v 55.0 (Summer '22) -- Update to Salesforce API v 54.0 (Spring '22) -- [Sticked table header to the top on export](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/10) -- Update to Salesforce API v 53.0 (Winter '22) -- Add label to saved query and sort list. -- Remove extra comma when autocomplete query in data export, or select a field from suggested fields just before 'FROM' keyword. - -Inspector menu - -- Add "Copy Id" option when clicking on a SObject field or Id in data export page. - -Inspector menu - -- Integrate UI updates from [Garywoo's fork](https://github.com/Garywoo/Chrome-Salesforce-inspector) +--8<-- "../CHANGES.md" diff --git a/mkdocs.yml b/mkdocs.yml index 07a11034..8841e978 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -39,7 +39,9 @@ markdown_extensions: - pymdownx.highlight: anchor_linenums: true - pymdownx.inlinehilite - - pymdownx.snippets + - pymdownx.snippets: + base_path: ["docs", "docs/screenshots"] + check_paths: true - admonition - pymdownx.arithmatex: generic: true From 6cf894e154c16b900613e1c39cbf1fcd41008bfe Mon Sep 17 00:00:00 2001 From: Thomas Prouvot Date: Mon, 18 Sep 2023 11:06:17 +0200 Subject: [PATCH 03/11] Remove extra line --- README.md | 64 ++++++++++++++++++++++++++----------------------------- 1 file changed, 30 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index a8dccdb7..980b2e58 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,3 @@ - # Salesforce inspector reloaded @@ -33,15 +32,15 @@ We all know and love Salesforce Inspector: As the great Søren Krabbe did not ha - [License](#license) ## New features compared to original SF Inspector ------ + [List of changes](CHANGES.md) -* Allow users to update API Version [feature 58](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/58) -* Add new "Shortcuts" tab to accelerate setup navigation [feature 42](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/42) -* Add shortcuts links to (list of record types, current SObject RecordType and objet details, show all data from user tab) from popup [feature 34](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/34) -* Control access to Salesforce Inspector reloaded with profiles / permissions (Implement Auth2 flow to generate access token for connected App) [how to](https://github.com/tprouvot/Salesforce-Inspector-reloaded/wiki/How-to#use-sf-inspector-with-a-connected-app) -* Update manifest version from [v2](https://developer.chrome.com/docs/extensions/mv3/mv2-sunset/) to v3 (extensions using manifest v2 will be removed from the store) -* New UI for Export / Import +- Allow users to update API Version [feature 58](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/58) +- Add new "Shortcuts" tab to accelerate setup navigation [feature 42](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/42) +- Add shortcuts links to (list of record types, current SObject RecordType and objet details, show all data from user tab) from popup [feature 34](https://github.com/tprouvot/Salesforce-Inspector-reloaded/issues/34) +- Control access to Salesforce Inspector reloaded with profiles / permissions (Implement Auth2 flow to generate access token for connected App) [how to](https://github.com/tprouvot/Salesforce-Inspector-reloaded/wiki/How-to#use-sf-inspector-with-a-connected-app) +- Update manifest version from [v2](https://developer.chrome.com/docs/extensions/mv3/mv2-sunset/) to v3 (extensions using manifest v2 will be removed from the store) +- New UI for Export / Import ## Security and Privacy @@ -57,7 +56,7 @@ To validate the accuracy of this description, inspect the source code, monitor t Follow steps described in [wiki](https://github.com/tprouvot/Salesforce-Inspector-reloaded/wiki/How-to#use-sf-inspector-with-a-connected-app) ## Installation ------ + From the Chrome Web Store : [Salesforce Inspector reloaded](https://chrome.google.com/webstore/detail/salesforce-inspector-relo/hpijlohoihegkfehhibggnkbjhoemldh) If you want to try it locally (to test the release candidate): @@ -70,13 +69,11 @@ If you want to try it locally (to test the release candidate): 6. Select the `addon` subdirectory of this repository. ## Troubleshooting ------ -* If Salesforce Inspector is not available after installation, the most likely issue is that your browser is not up to date. See [instructions for Google Chrome](https://productforums.google.com/forum/#!topic/chrome/YK1-o4KoSjc). -* When you enable the My Domain feature in Salesforce, Salesforce Inspector may not work until you have restarted your browser (or until you have deleted the "sid" cookie for the old Salesforce domain by other means). +- If Salesforce Inspector is not available after installation, the most likely issue is that your browser is not up to date. See [instructions for Google Chrome](https://productforums.google.com/forum/#!topic/chrome/YK1-o4KoSjc). +- When you enable the My Domain feature in Salesforce, Salesforce Inspector may not work until you have restarted your browser (or until you have deleted the "sid" cookie for the old Salesforce domain by other means). ## Contributions ------ Contributions are welcomed ! @@ -85,14 +82,13 @@ This branch will be merge into master when the new version is published on web s Linting : to assure indentation, formatting and best practices coherence, please install ESLint extension. - ## Development ------ 1. Install Node.js with npm 2. `npm install` ### Chrome + 1. `npm run chrome-dev-build` 2. Open `chrome://extensions/`. 3. Enable `Developer mode`. @@ -107,13 +103,12 @@ Linting : to assure indentation, formatting and best practices coherence, please 4. Select the file `addon/manifest.json`. ### Unit tests ------ 1. Set up an org (e.g. a Developer Edition) and apply the following customizations: - 1. Everything described in metadata in `test/`. Push to org with `sfdx force:source:deploy -p test/ -u [your-test-org-alias]` - 2. Ensure _Allow users to relate a contact to multiple accounts_ is enabled (Setup→Account Settings) - 3. Ensure the org has no _namespace prefix_ (Setup→Package Manager) - 4. Assign PermissionSet SfInspector + 1. Everything described in metadata in `test/`. Push to org with `sfdx force:source:deploy -p test/ -u [your-test-org-alias]` + 2. Ensure _Allow users to relate a contact to multiple accounts_ is enabled (Setup→Account Settings) + 3. Ensure the org has no _namespace prefix_ (Setup→Package Manager) + 4. Assign PermissionSet SfInspector 2. Navigate to one of the extension pages and replace the file name with `test-framework.html`, for example `chrome-extension://example/test-framework.html?host=example.my.salesforce.com`. 3. Wait until "Salesforce Inspector unit test finished successfully" is shown. 4. If the test fails, open your browser's developer tools console to see error messages. @@ -123,7 +118,7 @@ Linting : to assure indentation, formatting and best practices coherence, please 1. `npm run eslint` ## Release -------- + Version number must be manually incremented in [addon/manifest-template.json](addon/manifest-template.json) file ### Chrome @@ -135,23 +130,24 @@ If the version number is greater than the version currently in Chrome Web Store, 1. `npm run firefox-release-build` 2. Upload the file from `target/firefox/firefox-release-build.zip` to addons.mozilla.org -Design Principles ------ +## Design Principles + (we don't live up to all of them. pull requests welcome) -* Stay completely inactive until the user explicitly interacts with it. The tool has the potential to break Salesforce functionality when used, since we rely on monkey patching and internal APIs. We must ensure that you cannot break Salesforce just by having the tool installed or enabled. For example, we won't fix the setup search placeholder bug. -* For manual ad-hoc tasks only. The tool is designed to help administrators and developers interact with Salesforce in the browser. It is after all a browser add-on. Enabling automation is a non-goal. -* User experience is important. Features should be intuitive and discoverable, but efficiency is more important than discoverability. More advanced features should be hidden, and primary features should be central. Performance is key. -* Automatically provide as much contextual information as possible, without overwhelming the user. Information that is presented automatically when needed is a lot more useful than information you need to explicitly request. For example, provide autocomplete for every input. -* Provide easy access to the raw Salesforce API. Enhance the interaction in a way that does not break the core use case, if our enhancements fails. For example, ensure we can display the result of a data export even if we cannot parse the SOQL query. -* It is fine to implement features that are already available in the core Salesforce UI, if we can make it easier, smarter or faster. -* Ensure that it works for as many users as possible. (for system administrators, for standard users, with person accounts, with multi currency, with large data volumes, with professional edition, on a slow network etc.) -* Be conservative about the number and complexity of Salesforce API requests we make, but don't sacrifice the other principles to do so. -* Focus on system administrators, developers and integrators. + +- Stay completely inactive until the user explicitly interacts with it. The tool has the potential to break Salesforce functionality when used, since we rely on monkey patching and internal APIs. We must ensure that you cannot break Salesforce just by having the tool installed or enabled. For example, we won't fix the setup search placeholder bug. +- For manual ad-hoc tasks only. The tool is designed to help administrators and developers interact with Salesforce in the browser. It is after all a browser add-on. Enabling automation is a non-goal. +- User experience is important. Features should be intuitive and discoverable, but efficiency is more important than discoverability. More advanced features should be hidden, and primary features should be central. Performance is key. +- Automatically provide as much contextual information as possible, without overwhelming the user. Information that is presented automatically when needed is a lot more useful than information you need to explicitly request. For example, provide autocomplete for every input. +- Provide easy access to the raw Salesforce API. Enhance the interaction in a way that does not break the core use case, if our enhancements fails. For example, ensure we can display the result of a data export even if we cannot parse the SOQL query. +- It is fine to implement features that are already available in the core Salesforce UI, if we can make it easier, smarter or faster. +- Ensure that it works for as many users as possible. (for system administrators, for standard users, with person accounts, with multi currency, with large data volumes, with professional edition, on a slow network etc.) +- Be conservative about the number and complexity of Salesforce API requests we make, but don't sacrifice the other principles to do so. +- Focus on system administrators, developers and integrators. ## About ------ + By Thomas Prouvot and forked from [Søren Krabbe and Jesper Kristensen](https://github.com/sorenkrabbe/Chrome-Salesforce-inspector) ## License ------ + [MIT](./LICENSE) From 5d239030b397d2c3bacff8ae7c2739215ab7a7f8 Mon Sep 17 00:00:00 2001 From: Thomas Prouvot Date: Mon, 18 Sep 2023 11:09:20 +0200 Subject: [PATCH 04/11] Add documentation's link --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 980b2e58..eaa37161 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,10 @@ We all know and love Salesforce Inspector: As the great Søren Krabbe did not ha - [About](#about) - [License](#license) +## Documentation + +[Extension's doc](https://tprouvot.github.io/Salesforce-Inspector-reloaded/) + ## New features compared to original SF Inspector [List of changes](CHANGES.md) From 3f76343d9a3d8eac4236e1e1b836a24b6f50ccb5 Mon Sep 17 00:00:00 2001 From: Thomas Prouvot Date: Mon, 18 Sep 2023 11:11:39 +0200 Subject: [PATCH 05/11] Remove unused base-path for pymdownx --- mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index 8841e978..b1bf2fa9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -40,7 +40,7 @@ markdown_extensions: anchor_linenums: true - pymdownx.inlinehilite - pymdownx.snippets: - base_path: ["docs", "docs/screenshots"] + base_path: ["docs"] check_paths: true - admonition - pymdownx.arithmatex: From e2259bf6c3436342ef1d6eb55f2317841e34e2ee Mon Sep 17 00:00:00 2001 From: Thomas Prouvot Date: Mon, 18 Sep 2023 11:16:03 +0200 Subject: [PATCH 06/11] Fix base_path --- docs/index.md | 2 +- mkdocs.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/index.md b/docs/index.md index 27e2cd93..0edfe77d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -13,7 +13,7 @@ Chrome and Firefox extension to add a metadata layout on top of the standard Sal ## Release Note -[List of changes](/release-note) +[List of changes](/release-note.md) ## Best Features diff --git a/mkdocs.yml b/mkdocs.yml index b1bf2fa9..4a1afbea 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -40,7 +40,7 @@ markdown_extensions: anchor_linenums: true - pymdownx.inlinehilite - pymdownx.snippets: - base_path: ["docs"] + base_path: docs check_paths: true - admonition - pymdownx.arithmatex: From 69c7cc139103037400c1af0b3ff206d3364fc063 Mon Sep 17 00:00:00 2001 From: Thomas Prouvot <35368290+tprouvot@users.noreply.github.com> Date: Tue, 19 Sep 2023 17:21:33 +0200 Subject: [PATCH 07/11] Add 'How to access recycle bin' --- docs/how-to.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/how-to.md b/docs/how-to.md index 368d604d..78a5c548 100644 --- a/docs/how-to.md +++ b/docs/how-to.md @@ -56,3 +56,7 @@ To secure the extension usage, you can use a auth flow to get an access token li ``` Re-import this json in the new extension (with the same key "insextSavedQueryHistory") + +## Access Recycle Bin from Objects tab +![2023-09-19_16-59-10 (1)](https://github.com/tprouvot/Salesforce-Inspector-reloaded/assets/35368290/bfab8827-c78f-40ac-b26f-4bb27cf20425) + From 7b16c55475065babdc288a3041699c9504e58ee3 Mon Sep 17 00:00:00 2001 From: Thomas Prouvot <35368290+tprouvot@users.noreply.github.com> Date: Wed, 27 Sep 2023 11:55:45 +0200 Subject: [PATCH 08/11] Update mkdocs.yml (#162) --- mkdocs.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index 4a1afbea..9e5331ed 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -40,7 +40,8 @@ markdown_extensions: anchor_linenums: true - pymdownx.inlinehilite - pymdownx.snippets: - base_path: docs + base_path: + - CHANGES.md check_paths: true - admonition - pymdownx.arithmatex: From 4636447241abcae16b9b65f4979756545c52814c Mon Sep 17 00:00:00 2001 From: Thomas Prouvot <35368290+tprouvot@users.noreply.github.com> Date: Wed, 27 Sep 2023 14:07:11 +0200 Subject: [PATCH 09/11] Update release-note.md (#163) --- docs/release-note.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/release-note.md b/docs/release-note.md index 38232137..6d840f8b 100644 --- a/docs/release-note.md +++ b/docs/release-note.md @@ -1 +1 @@ ---8<-- "../CHANGES.md" +--8<-- "CHANGES.md" From f2fa5e4b3f2f289f5c9599b3b667b2d9b021f2b8 Mon Sep 17 00:00:00 2001 From: Thomas Prouvot <35368290+tprouvot@users.noreply.github.com> Date: Wed, 25 Oct 2023 09:57:47 +0200 Subject: [PATCH 10/11] Update README.md Add Edge store installation link --- README.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index eaa37161..fc07606f 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,10 @@ We all know and love Salesforce Inspector: As the great Søren Krabbe did not ha - [Security and Privacy](#security-and-privacy) - [Use Salesforce Inspector with a Connected App](#use-salesforce-inspector-with-a-connected-app) - [Installation](#installation) + - [Browser Stores](#browser-stores) + - [Chrome Web Store](https://chrome.google.com/webstore/detail/salesforce-inspector-relo/hpijlohoihegkfehhibggnkbjhoemldh) + - [Firefox Browser Add-ons](https://addons.mozilla.org/en-US/firefox/addon/salesforce-inspector-reloaded/) + - [Edge Add-ons](https://microsoftedge.microsoft.com/addons/detail/salesforce-inspector-relo/noclfopoifgfgnflgkakofglfeeambpd) - [Troubleshooting](#troubleshooting) - [Contributions](#contributions) - [Development](#development) @@ -61,16 +65,11 @@ Follow steps described in [wiki](https://github.com/tprouvot/Salesforce-Inspecto ## Installation -From the Chrome Web Store : [Salesforce Inspector reloaded](https://chrome.google.com/webstore/detail/salesforce-inspector-relo/hpijlohoihegkfehhibggnkbjhoemldh) +### Browser Stores -If you want to try it locally (to test the release candidate): - -1. Download or clone the repo. -2. Checkout the releaseCandidate branch. -3. Open `chrome://extensions/`. -4. Enable `Developer mode`. -5. Click `Load unpacked extension...`. -6. Select the `addon` subdirectory of this repository. +- [Chrome Web Store](https://chrome.google.com/webstore/detail/salesforce-inspector-relo/hpijlohoihegkfehhibggnkbjhoemldh) +- [Firefox Browser Add-ons](https://addons.mozilla.org/en-US/firefox/addon/salesforce-inspector-reloaded/) +- [Edge Add-ons](https://microsoftedge.microsoft.com/addons/detail/salesforce-inspector-relo/noclfopoifgfgnflgkakofglfeeambpd) ## Troubleshooting From 7dc0be87b955c1129373fb870887c57cfe11057f Mon Sep 17 00:00:00 2001 From: Thomas Prouvot <35368290+tprouvot@users.noreply.github.com> Date: Wed, 25 Oct 2023 14:47:22 +0200 Subject: [PATCH 11/11] Update bug_report.md --- .github/ISSUE_TEMPLATE/bug_report.md | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index af31e0a9..1c230fb4 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -25,14 +25,8 @@ If applicable, add screenshots to help explain your problem. **Desktop (please complete the following information):** - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] + - Browser [e.g. chrome, firefox, edge] + - Version [e.g. 1.20] **Additional context** Add any other context about the problem here.