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

Import/Export in the uP5 Manual(#1241) #2859

Merged
merged 1 commit into from
Oct 9, 2024

Conversation

555vedant
Copy link
Contributor

This PR updates the Import/Export tool documentation for uPortal to reflect the new commands in uP5. It replaces outdated commands with the current syntax and usage, ensuring accuracy and clarity. The documentation includes step-by-step instructions and examples to guide users through the Import/Export process. Additionally, it addresses any discrepancies found in the previous version.

@ChristianMurphy ChristianMurphy added Hacktoberfest documentation good for contributors to provide some missing documentations labels Oct 1, 2024
@555vedant
Copy link
Contributor Author

@ChristianMurphy ready to merge ?

@ChristianMurphy
Copy link
Member

@555vedant enhance your calm, give people a chance to review. 🙂

docs/import_export/README.md Show resolved Hide resolved
docs/import_export/README.md Show resolved Hide resolved
docs/import_export/README.md Show resolved Hide resolved
docs/import_export/README.md Show resolved Hide resolved
docs/import_export/README.md Outdated Show resolved Hide resolved
docs/import_export/README.md Outdated Show resolved Hide resolved
docs/import_export/README.md Outdated Show resolved Hide resolved
docs/import_export/README.md Outdated Show resolved Hide resolved
docs/import_export/README.md Outdated Show resolved Hide resolved
docs/import_export/README.md Show resolved Hide resolved
@555vedant
Copy link
Contributor Author

@ChristianMurphy thnx for suggestions

docs/import_export/README.md Outdated Show resolved Hide resolved
docs/import_export/README.md Outdated Show resolved Hide resolved
docs/import_export/README.md Outdated Show resolved Hide resolved
@jonathanmtran
Copy link
Contributor

With uPortal 5, the data import/export tasks are invoked using Gradle. The commands and its parameters are same for the most part, so the documentation needs to be updated to reflect that

@555vedant
Copy link
Contributor Author

in this format template is more readable !!

Copy link
Contributor

@jonathanmtran jonathanmtran left a comment

Choose a reason for hiding this comment

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

Running ./gradlew :overlays:uPortal:tasks outputs the following

Data tasks
----------
dataDelete - Deletes the specified entity. Requires -Dtype={entity-type} and -Dsysid={id}
dataExport - Creates XML files representing the requested entities and writes them to the specified file system location. Parameters: -Ddir={path-to-directory} -Dtype={entity-type} [-Dsysid={entity-identifier}]
dataImport - Adds to or updates the portal database for the entities defined in the specified XML file(s). Requires -Dfile={path-to-file} or -Ddir={path-to-directory}
dataInit - Drop and recreate uPortal tables and reimport data
dataList - With no arguments (-Dtype={entity-type}) lists all supported portal data types and the operations (export, delete) supported for each.

src: https://github.com/uPortal-Project/uPortal-start/blob/master/overlays/uPortal/build.gradle

@555vedant
Copy link
Contributor Author

@jonathanmtran Changes done.

docs/import_export/README.md Show resolved Hide resolved
docs/import_export/README.md Show resolved Hide resolved
docs/import_export/README.md Show resolved Hide resolved
docs/import_export/README.md Show resolved Hide resolved
docs/import_export/README.md Show resolved Hide resolved
docs/import_export/README.md Show resolved Hide resolved
@555vedant
Copy link
Contributor Author

@jonathanmtran PR ready to merge ??

@jonathanmtran
Copy link
Contributor

Please squash the commits into one

@555vedant
Copy link
Contributor Author

@jonathanmtran squashing done

@jonathanmtran jonathanmtran merged commit 8f23dca into uPortal-Project:master Oct 9, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation good for contributors to provide some missing documentations Hacktoberfest
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants