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

#1761 Document Islandora Advanced Search #1829

Merged
merged 5 commits into from
Jun 8, 2021
Merged

#1761 Document Islandora Advanced Search #1829

merged 5 commits into from
Jun 8, 2021

Conversation

manez
Copy link
Member

@manez manez commented May 20, 2021

Purpose / why

Create a new page documenting how to configure new Advanced Search. Resolves #1761

What changes were made?

New .md, new screenshots in the assets folder, and new entry in mkdocs.yml to add the page to the tree.

Verification

Review! This is mostly lifted from the great docs @nigelgbanks already made in the readme: https://github.com/nigelgbanks/islandora/blob/8.x-1.x-advanced-search/modules/islandora_advanced_search/README.md, with some changes to make it a docs page instead of a readme and to fit the style guide.

Interested Parties

@Islandora/documentation and @nigelgbanks


Checklist

Pull-request reviewer should ensure the following

  • Does this PR link to related issues?
  • Does the proposed documentation align with the Islandora Documentation Style Guide?
  • Are the changes accurate, useful, free of typos, etc?
  • Does this PR update the last updated on date on the documentation page?

Person merging should ensure the following

  • Does mkdocs still build successfully? (This is indicated by TravisCI passing. To test locally, and see warnings, see How To Build Documentation.)
  • If pages are renamed or removed, have all internal links to those pages been fixed?
  • If pages are added, have they been linked to or placed in the menu?
  • Did the PR receive at least one approval from a committer, and all issues raised have been addressed?

manez and others added 3 commits May 20, 2021 10:10

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
@rosiel
Copy link
Member

rosiel commented Jun 8, 2021

I tested locally. It can't find the images, I think you might need ../../assets?

@manez
Copy link
Member Author

manez commented Jun 8, 2021

Gave that a try! They are now all broken in my repo, but if they built in the real docs, then 👍

@eldonquijote
Copy link
Contributor

I think that's one .. too many, you need to go one level up and then one down into the assets folder:
../assets/

@manez
Copy link
Member Author

manez commented Jun 8, 2021

That does look better in the browser view

@rosiel
Copy link
Member

rosiel commented Jun 8, 2021

Action gifs! Nice!

@rosiel rosiel merged commit b32ee4e into Islandora:main Jun 8, 2021
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.

Document new Advanced Search module once merged
3 participants