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

Webpage update #511

Merged
merged 23 commits into from
May 9, 2022
Merged

Webpage update #511

merged 23 commits into from
May 9, 2022

Conversation

martinpub
Copy link
Collaborator

@martinpub martinpub commented Apr 11, 2022

Hi @josteinaj!

This PR starts an update of the Nordic Migrator web page, preparing for an official release (following #396).

So far, I have updated the structure and gone through the About section, let me know what you think.

I suggest we leave this PR open until we are ready to publish (and I guess the GH web page is based directly off of the state of the gh-pages branch), so more commits will follow before it's ready for merging.

@martinpub
Copy link
Collaborator Author

Hi again @josteinaj, I added an update of the Resources section.

  • Changed links to EPUB guidelines documents now published on format.mtm.se
  • Removed outdated links
  • Grouped links

A question, should we make an updated list of validation rules for 2020-1 guidelines? I have a vague memory of us/Hugo starting on something like that early on in the guidelines update process? Noting that this is only for 2015-1 at the moment, sticking with minimally required updates at this point. But it would be nice to point to something similar for 2020-1 guidelines.

Next, i will turn my attention to testing the installation methods again from a user perspective, and see if there are any changes/clarifications to be done in that section.

@josteinaj
Copy link
Member

Hi @martinpub. Looks great!

Yes, let's wait with merging until we release a new version.

Having an updated list of validation rules for 2020-1 would be useful, but maybe not required for making a release. It's good that you remembered it, I had totally forgot about it. There's a couple of 2020-XSLTs here thatwe can run: https://github.com/nlbdev/nordic-epub3-dtbook-migrator/tree/guidelines-revision/documentation

@josteinaj
Copy link
Member

I've made a release now. Version 1.5.0:

The Docker image has not finished building yet, but unless something goes wrong, it will be available very soon: https://hub.docker.com/r/nlbdev/nordic-epub3-dtbook-migrator

@martinpub
Copy link
Collaborator Author

Great work @josteinaj!

Will continue with the docs update.

BTW, did you see my question in #396?

@martinpub
Copy link
Collaborator Author

@josteinaj I added the HTML documents generated from the Schematron XSLT. I think there is room for improvement when it comes to presentation, e.g. duplication of rule numbers, unclear distinction between "Global" and "Detailed" description, etc. Do you think it is useful as is? I'm not sure but I guess it doesn't hurt to add it. I hope it is not confusing to new users, but it might be ...

@josteinaj
Copy link
Member

Hi @martinpub. I haven't had time to look at it yet but it doesn't hurt to add it, as you say, and we can improve it later if needed.

@martinpub
Copy link
Collaborator Author

Hi @martinpub. I haven't had time to look at it yet but it doesn't hurt to add it, as you say, and we can improve it later if needed.

OK, great. Logged this task separately in #513, will leave it as is for now.

@josteinaj
Copy link
Member

@martinpub can I merge this now or do you want to make more changes first?

@martinpub
Copy link
Collaborator Author

Hi @josteinaj, I have some minor edits left, and was still thinking about how best to phrase the Docker instructions, which will be most important.

@martinpub
Copy link
Collaborator Author

Hi again @josteinaj, made some additions now. What do you think about this? I have tried to strike a balance between a somewhat user-friendly explanation of the easiest way to run the migrator while not getting too deep into the specifics of various Docker setups.

Are there any updates to be made to the Pipeline 2 updater section based on the current release status?

Ping also @AndersEkl, do you see any obvious things we need to add/change?

If you both approve the changes, I guess they can be merged now. If we get questions later on, we can clarify and update the web page docs.

@AndersEkl
Copy link
Collaborator

AndersEkl commented May 4, 2022

Ping also @AndersEkl, do you see any obvious things we need to add/change?

@martinpub Where should I go in and read?

@martinpub
Copy link
Collaborator Author

martinpub commented May 5, 2022

@martinpub Where should I go in and read?

Yeah, sorry @AndersEkl, probably not the most straight-forward in a pending PR, but here is a link to index.html in the PR, where most of the changes are at.

@josteinaj
Copy link
Member

I'm just gonna merge this one. We can easily adjust it later if needed (either directly or in a PR).

@josteinaj josteinaj merged commit 6b2a53f into nlbdev:gh-pages May 9, 2022
@martinpub
Copy link
Collaborator Author

I'm just gonna merge this one. We can easily adjust it later if needed (either directly or in a PR).

Thanks @josteinaj!

@martinpub martinpub deleted the webpage_update branch May 10, 2022 06:37
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.

None yet

3 participants