Skip to content
This repository has been archived by the owner on Oct 5, 2020. It is now read-only.

additions/tweaks to documentation #291

Open
patrickmcelwee opened this issue Jan 21, 2016 · 9 comments
Open

additions/tweaks to documentation #291

patrickmcelwee opened this issue Jan 21, 2016 · 9 comments

Comments

@patrickmcelwee
Copy link
Contributor

These are basically my stream-of-consciousness notes while going through installation with an SE:

  1. document in README how to set up mlcp: where to install and how to change mlcp_home
  2. make the initial landing page leaner, with directions on how to edit that file and suggestions for first steps - the links are a nice compilation that should live somewhere, but I think we want something much leaner for someone who, after all, is trying to build something. Something simple and geared to beginners, like the Rails landing page: http://www.attilaszomor.com/blog/wp-content/uploads/2010/05/rails_welcome_screen.png 'How to change this page', for example.
  3. link to the wiki for further documentation on this simplified landing page
@grtjn
Copy link
Contributor

grtjn commented Jan 22, 2016

+1 on all this, I like the sound of this a lot. There is useful stuff on that landing page, but focussing it more on how to get 'rolling' feels much better than just flooding new users with a lot of links.

I'd also like if there would be a few generic stat kind of things on the landing page. Very generic counts on node types, root elements, collections, dirs. And/or maybe something about the machine(s) behind the demo, like ML version, architecture, nr cores, mem, nr forests, etc. Stuff that would work for every demo, and give actual use to the landing page, so people will be less inclined to get rid of it first..

@patrickmcelwee
Copy link
Contributor Author

Those sound like great additions, Geert. I'd be happy to take a first stab, though I'm sure I will need help pulling all those extra stats in.

@patrickmcelwee patrickmcelwee self-assigned this Jan 22, 2016
@patrickmcelwee
Copy link
Contributor Author

We discussed having some common elements, but also a high degree of customization between the various UI themes currently being developed

@grtjn
Copy link
Contributor

grtjn commented Feb 18, 2016

See also #309, #310, #311..

@grtjn
Copy link
Contributor

grtjn commented Feb 18, 2016

I think we need to split this into specific issues once it has crystallized..

@popzip
Copy link
Contributor

popzip commented Apr 27, 2016

I keep hitting this and forgetting...added here for searchability within the repository:
I had to add mlcp-home=/YOUR/PATH/mlcp-8.0-4 to deploy/local.properties

It's listed in the wiki which unfortunately doesn't turn up when I search the repo.

@grtjn
Copy link
Contributor

grtjn commented May 9, 2016

@popzip, I just symlink from /usr/local/mlcp to the appropriate path. Much easier.. :)

@grtjn
Copy link
Contributor

grtjn commented May 9, 2016

And yes, it would be nice if Github would provide a wiki search feature..

grtjn added a commit to grtjn/slush-marklogic-node that referenced this issue Nov 22, 2016
grtjn added a commit to grtjn/slush-marklogic-node that referenced this issue Nov 22, 2016
grtjn added a commit to grtjn/slush-marklogic-node that referenced this issue Nov 22, 2016
@grtjn
Copy link
Contributor

grtjn commented Nov 22, 2016

I made a lot of improvements to README, and added a few links to the landing page. I think we need to refresh this ticket, but the general thought of moving the many links away from the landing page still stands..

janmichaelyu added a commit to janmichaelyu/slush-marklogic-node that referenced this issue Apr 13, 2017
* Fixed marklogic-community#288: by-pass auth entirely in node with few lines

* marklogic-community#288: refined logic a bit

* Fixed permissions, improved init-local

* marklogic-community#288: refinements, and test issues

* Final changes

* Fixed a few missing dependencies

* Found some last minute bugs

* Some final refinements on the node-server

* Fixed marklogic-community#287: added helmet package for slightly better security

* Refined marklogic-community#287 based on latest HelmetJS changes

* Use an auth helper that can handle digest authentication marklogic-community#284

* Added pm2 config generation

* Updated README with how to use pm2

* Updated readme, tidied js files and replaced previous gulp tasks with gulp add-deploy-target

* Updated to support local.ecosystem.json and to have a separate Install guide

* adjusted code style

* Created an encoding variable in the slushfile

* Use passport LocalStrategy

* Add back lost logic on guest access, etc.

* Put skipBinary into it's own variable

* Updated readmes

* added feature to edit documents
added feature to delete documents
added feature to choose file type to save the data
added feature to validate data before saving

* default view of the document is based on the document format e.g. if the document is json, default view is json

* test

* fixed docFormat typo

* fix on conflicts

* fixed based on geert's review points

* ordered alphabetically the dependencies

* Implemented fixes based on review points

* Added delete confirmation

* change equality operations

* Fixed errors in unit tests

* Fix: Jquery should be listed ahead of any angular dependency to make sure angular uses it

* Fix for the map unit tests

* Fixes based on review points

* Fixed: map create form shows validation errors on open

* Added sudo and amended some of the commands for removing services

* Updated readme and removed /etc

* updated sample data to include docFormat

* Added form validations
Fixed unit test to support both create and edit

* Fixed confirmation message

* Moved the map detail buttons to the top
Moved the default details buttons to the right on top of similar panel

* justify buttons

* Add triples to sample data

This commit adds the following triples to each sample document:

<docUri> <rdfs:label> <doc/name> .
<docUri> <rdf:type> <foaf:Person> .

and three triples pointing to 3 random documents:

<docUri> <foaf:knows> <someRandomDocUriFromThisSampleSet>

There is also a single additional triple in the first doc
('data-0.json') that establishes a label for `foaf:knows`. This would
normally go into an ontology, but it seemed easiest just to embed it
into a document rather than introduce that much complexity. This
additional triple is needed for a nice OOTB display when using
[ml-visjs-graph-ng](https://github.com/patrickmcelwee/ml-visjs-graph-ng)

These triples were inserted into the original sample docs using [this
sample-triple-generator
library](https://github.com/patrickmcelwee/sample-triple-generator), in
case that is a helpful starting point for any future additions.

* Hide 'Edit' and 'Delete' when `disallowUpdates: true`

Previously, the buttons still appeared, but resulted in a blank page for
'Edit' and an unhandled server error for 'Delete'.

This requires added the userService and $scope as additional
dependencies in the generated detail controller.

It seems that only the map theme has an override for the detail
controller. I made the changes there as well.

* fixing the footer logo for bug marklogic-community#382

* Fixed marklogic-community#391: added cmd options for all questions

* Fixed marklogic-community#389: issue with gulp build and postcss for older node versions

* marklogic-community#391: allow running slushfile with gulp directly for easier testing

* marklogic-community#391: Allow app-name as gulp arg

* marklogic-community#391: ignore gulpfile arg

* marklogic-community#391: small bug in xcc-port

* marklogic-community#391: theme argument was not handled correctly

* Fixed marklogic-community#398: added OOTB logic for all Google overlay types

* Fixed marklogic-community#398: commented out marker/polyline, we don't do proximity search (yet)

* Define variables that were left undefined

Fixes marklogic-community#405

* for review

TODO: there is a bug in the co-occerence

* set no limit to get all combinations

* support broke on the new version of ml-highcharts-ng

* remove range element index on eyeColor in favor of the range path index

* use range path index in favor of the json index

* Fine-tuned dashboard charts, and fixed node-server proxy

* Fixed marklogic-community#397: proper init of auth-helper, and defaulting of user/pass

* marklogic-community#243: Initial progress with code cleanup and code coverage

* marklogic-community#243: minor bug in create ctrl tests

* marklogic-community#243: fixed gulp build for dashboard/map themes, further code and test coverage improvements, and code cleanup

* Fixed marklogic-community#384: setting unlimited timeout, ML will eventually time out

* Fixed marklogic-community#329: improved user endpoints in middle-tier

* Fixed marklogic-community#377: added stub user profile for admin user

* marklogic-community#384: capturing socket timeout for better exception handling

* Refined documentation and next step links, fixes marklogic-community#375, fixes marklogic-community#388, fixes marklogic-community#419, and fixes marklogic-community#421

* Fixed marklogic-community#385: replaced undocumented xdmp:content-type with official xdmp:uri-content-type

* Fixes marklogic-community#373: added extractedToJson.sjs rest transform

* Improving marklogic-community#291, and marklogic-community#410: added notes on mlcp-home to README

* Fixed link to INSTALL docs

* Fixed link to INSTALL docs

* Adding documentation for the proper use of MLCP in Windows.

* Fixed landing page panel issue, cleaned up rest transforms

* Release 1.2.0

* Release 1.2.0

* first commit for the marklogic-community#411 ticket. Missing the all.xml and ml-config.xml.

* fixing bug with the panels on the landing page

* Rebased cards-theme on top of latest changes, and consolidation across themes

* Fixed col-sx/xs typo

* Fixed typo in sanitize.xsl

* Added view-file-ng to detail page

* Test scripts

* Added showHome toggle

* Fixed app.route dependency

* Fixed app.route dependency

* Fixed app.route dependency

* refinements for marklogic-community#411. Added the blue variant

* changed the -xs- to 12 for repsonsive fix

* Fixed marklogic-community#433: temp fix for old node versions

* first commit for the marklogic-community#411 ticket. Missing the all.xml and ml-config.xml.

* fixing bug with the panels on the landing page

* Rebased cards-theme on top of latest changes, and consolidation across themes

* Fixed col-sx/xs typo

* Fixed typo in sanitize.xsl

* Added view-file-ng to detail page

* Test scripts

* Added showHome toggle

* Fixed app.route dependency

* Fixed app.route dependency

* Fixed app.route dependency

* refinements for marklogic-community#411. Added the blue variant

* changed the -xs- to 12 for repsonsive fix

* Do not add padding to .row in the dashboard theme

In Bootstrap, .row has no padding (and in fact has a negative margin)
to allow for nested columns. I just ran into this setting on a
dashboard-style demo, where I could not figure out why my nested columns
keep getting more and more indented.

I believe that this line of css was added to fix the search screen for
the dashboard theme. But a better fix is to use the "content" class
provided by AdminLTE. This is what I have done on my own demo, and it is
working well. It is also what the AdminLTE site does (though it is oddly
undocumented): https://almsaeedstudio.com/themes/AdminLTE/index2.html

* updating the colors to match the brand removal of blue. fixing a couple coloring issues as well

* Various changes for cards-theme

* adding fixes to the spacing for a fixed header

* make SSL support configurable

* rearranged notes

* change headings

* restore bower.json

* removed redundant log
fixed comment

*  rebase 401 work on cards-theme branch

* rearranged notes

* change headings

* removed redundant log
fixed comment

* Fixed typos in rest transforms

* SW-9  Added documentation on how to run in production.  This update creates a link to the documents.

* Fixed marklogic-community#442: making sure middle-tier uses digest auth against MarkLogic

* Added logic to error interceptor to redirect to a login screen when the user becomes unauthorised and formatted the create controller code

* adds new, explicitly white-listed REST API proxy

* Fixed marklogic-community#450: work-around for ml info throwing error + extra feedback about npm install, bower install, and gulp init

* Fixed marklogic-community#436: using os-homedir instead of ~

* Fixed marklogic-community#387: added note on how to accept RSA fingerprints + general cleanup of INSTALL.md

* Some more changes for marklogic-community#450, small bug with admin pwd handling in wizard, adjusted test script

* Fixed marklogic-community#451: index should point to min js/css, not .map, fixed. Also fixed endless gulp build, related to earlier commits for marklogic-community#450.

* Disabling term-options to allow ML to toggle options automatically

* Fixing typo in sanitize.xsl, again..

* Fixing content-db defaults in ml-config using xmlpoke, for better consistency accross ML versions

* Fixed marklogic-community#458: properly coded registered dateTime in sample-data

* Fixed marklogic-community#461: different handling of showHome false to fix navigation

* Improved fix for marklogic-community#438: skip vkbeautify-wrapper entirely

* Fixing gulp build issue

* Fix marklogic-community#467 - Allow /v1/values to proxy properly

* Updated CHANGELOG with current status

* Fixed marklogic-community#475: removed hardcoded sinon release

* Fixed marklogic-community#471: replaced @sample-app-role with dynamic -role in mlcp options

* Fixed marklogic-community#470: fixed handling of appname in login service

* Fixed marklogic-community#465: renamed ctrl to  in all html views

* Fixed  in directives

* Fixed marklogic-community#482: made sure authenticators are cleared properly at /user/logout, and code reformatting of all node-server files

* getAuthenticatedStatus needs to always return promise

If the _isAuthenticated memo was already set, it was returned a bald
value, without wrapping in a promise

Also, I found and threw the error that wasn't showing up - which would
have helped debug this issue.

Fixes marklogic-community#480

* Simplify consumer of getAuthenticatedService

Does not need to check if it returns promise or not, since always should

* Wrap getUser return to always return promise

* Included WINDOWS readme to generated apps

* Final touches on READMEs

* Making sure extsimilar works on binaries

* Fixed marklogic-community#484: no longer extract full doc at search by default

* Fixed small issue with Cancel on Create/Edit page

* Updated CHANGELOG and package.json for 1.3.0

* fixes for marklogic-community#490 which is to remove the blue less files

* Updated CHANGELOG

* Updated favicon
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants