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: improve readme #20

Merged
merged 3 commits into from
Nov 1, 2023
Merged

docs: improve readme #20

merged 3 commits into from
Nov 1, 2023

Conversation

bra-i-am
Copy link
Contributor

Description

This PR modifies the readme to have consigned the primary goal of this MFE and shows how to have it in a basic development environment.

@bra-i-am bra-i-am requested a review from dcoa October 11, 2023 17:36
README.rst Outdated Show resolved Hide resolved
@dcoa dcoa requested a review from MaferMazu October 12, 2023 03:58
@dcoa
Copy link
Collaborator

dcoa commented Oct 12, 2023

Thanks for the PR @bra-i-am

There are some points that I think should improve:

  1. You need to be clear about the configuration of the platform, I mean, is a must to define VALIDATION_PANEL_MFE_URL in the settings.

  2. I would rather have developing instructions like example because we use Tutor but should not be limited to that, in addition, making reference to course-authoring without an explanation will be confusing.

  3. Don't forget the deploying instructions (here could be the right point to add the tutor recommendation) and use the tutor instructions to add a new MFE.

I added @MaferMazu as a reviewer understanding her wide knowledge of technical documentation.

@MaferMazu
Copy link

MaferMazu commented Oct 12, 2023

I will add that it would be cool to have a no-developer installation. For example: https://github.com/eduNEXT/platform-global-teacher-campus#getting-started.
Something like:

  • Add X in your config.yml
  • Save with tutor config save
  • Create the mfe image tutor images build mfe
  • Launch the platform tutor local launch

I think it's important because we probably will install this plugin more than we want to continue to develop over this, and this is not installed by default by tutor-mfe like other mfes.

Btw I only suggest; you feel free to improve my example xD

Another btw, this PR should be a "docs" instead of "refactor".

@bra-i-am bra-i-am changed the title refactor: improve readme docs: improve readme Oct 13, 2023
README.rst Outdated Show resolved Hide resolved
@bra-i-am bra-i-am merged commit d29bb8b into master Nov 1, 2023
3 checks passed
@bra-i-am bra-i-am deleted the bc/adjust-readme branch November 1, 2023 16:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants